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
29 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.124 2006/10/10 09:44:08 ru Exp $
36 .Nd configure network interface parameters
77 utility is used to assign an address
78 to a network interface and/or configure
79 network interface parameters.
82 utility must be used at boot time to define the network address
83 of each interface present on a machine; it may also be used at
84 a later time to redefine an interface's address
85 or other operating parameters.
87 The following options are available:
88 .Bl -tag -width indent
91 .Tn DARPA Ns -Internet
93 the address is either a host name present in the host name data
98 Internet address expressed in the Internet standard
101 It is also possible to use the CIDR notation (also known as the
102 slash notation) to include the netmask.
103 That is, one can specify an address like
108 family, it is also possible to specify the prefix length using the slash
113 parameter below for more information.
114 .\" For the Xerox Network Systems(tm) family,
116 .\" .Ar net:a.b.c.d.e.f ,
119 .\" is the assigned network number (in decimal),
120 .\" and each of the six bytes of the host number,
124 .\" are specified in hexadecimal.
125 .\" The host number may be omitted on IEEE 802 protocol
126 .\" (Ethernet, FDDI, and Token Ring) interfaces,
127 .\" which use the hardware physical address,
128 .\" and on interfaces other than the first.
131 .\" family, addresses are specified as a long hexadecimal string,
132 .\" as in the Xerox family.
133 .\" However, two consecutive dots imply a zero
134 .\" byte, and the dots are optional, if the user wishes to (carefully)
135 .\" count out long strings of digits in network byte order.
140 is specified as a series of colon-separated hex digits.
142 e.g.\& set a new MAC address on an ethernet interface, though the
143 mechanism used is not ethernet-specific.
144 If the interface is already
145 up when this option is used, it will be briefly brought down and
146 then brought back up again in order to ensure that the receive
147 filter in the underlying ethernet hardware is properly reprogrammed.
148 .It Ar address_family
151 which affects interpretation of the remaining parameters.
152 Since an interface can receive transmissions in differing protocols
153 with different naming schemes, specifying the address family is recommended.
154 The address or protocol families currently
173 Specify the address of the correspondent on the other end
174 of a point to point link.
177 parameter is a string of the form
183 The following parameters may be set with
185 .Bl -tag -width indent
190 Introduced for compatibility
194 Establish an additional network address for this interface.
195 This is sometimes useful when changing network numbers, and
196 one wishes to accept packets addressed to the old interface.
197 If the address is on the same subnet as the first network address
198 for this interface, a non-conflicting netmask must be given.
203 Remove the network address specified.
204 This would be used if you incorrectly specified an alias, or it
205 was no longer needed.
206 If you have incorrectly set an NS address having the side effect
207 of specifying the host portion, removing all NS addresses will
208 allow you to respecify the host portion.
211 Specify that the address configured is an anycast address.
212 Based on the current specification,
213 only routers may configure anycast addresses.
214 Anycast address will not be used as source address of any of outgoing
217 Enable the use of the Address Resolution Protocol
220 between network level addresses and link level addresses (default).
221 This is currently implemented for mapping between
226 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
228 Disable the use of the Address Resolution Protocol
231 If the Address Resolution Protocol is enabled,
232 the host will only reply to requests for its addresses,
233 and will never send any requests.
235 If the Address Resolution Protocol is enabled,
236 the host will perform normally,
237 sending out requests and listening for replies.
240 Specify the address to use to represent broadcasts to the
242 The default broadcast address is the address with a host part of all 1's.
244 Enable driver dependent debugging code; usually, this turns on
245 extra console error logging.
247 Disable driver dependent debugging code.
249 Put interface into permanently promiscuous mode.
251 Disable permanently promiscuous mode.
259 When an interface is marked
261 the system will not attempt to
262 transmit messages through that interface.
263 If possible, the interface will be reset to disable reception as well.
264 This action does not automatically disable routes using the interface.
268 (lowermost 64bit of an IPv6 address)
271 This is used to specify an Internet host who is willing to receive
272 IP packets encapsulating IPX packets bound for a remote network.
273 An apparent point to point link is constructed, and
274 the address specified will be taken as the IPX address and network
277 If the driver supports the media selection system, set the media type
280 Some interfaces support the mutually exclusive use of one of several
281 different physical media connectors.
282 For example, a 10Mbit/s Ethernet
283 interface might support the use of either
285 or twisted pair connectors.
286 Setting the media type to
288 would change the currently active connector to the AUI port.
291 would activate twisted pair.
292 Refer to the interfaces' driver
293 specific documentation or man page for a complete list of the
295 .It Cm mediaopt Ar opts
296 If the driver supports the media selection system, set the specified
297 media options on the interface.
301 is a comma delimited list of options to apply to the interface.
302 Refer to the interfaces' driver specific man page for a complete
303 list of available options.
304 .It Fl mediaopt Ar opts
305 If the driver supports the media selection system, disable the
306 specified media options on the interface.
308 If the driver supports the media selection system, set the specified
309 operating mode on the interface to
311 For IEEE 802.11 wireless interfaces that support multiple operating modes
312 this directive is used to select between 802.11a
320 Set the interface name to
323 If the driver supports receive side scaling,
324 enable receive side scaling on the interface.
326 If the driver supports receive side scaling,
327 disable receive side scaling on the interface.
328 .It Cm rxcsum , txcsum
329 If the driver supports user-configurable checksum offloading,
330 enable receive (or transmit) checksum offloading on the interface.
331 Some drivers may not be able to enable these flags independently
332 of each other, so setting one may also set the other.
333 The driver will offload as much checksum work as it can reliably
334 support, the exact level of offloading varies between drivers.
335 .It Fl rxcsum , txcsum
336 If the driver supports user-configurable checksum offloading,
337 disable receive (or transmit) checksum offloading on the interface.
338 These settings may not always be independent of each other.
340 If the driver supports TCP segmentation offloading,
341 enable TCP segmentation offloading on the interface.
343 If the driver supports TCP segmentation offloading,
344 disable TCP segmentation offloading on the interface.
345 .It Cm vlanmtu , vlanhwtag
346 If the driver offers user-configurable VLAN support, enable
347 reception of extended frames or tag processing in hardware,
349 Note that this must be issued on a physical interface associated with
354 .It Fl vlanmtu , vlanhwtag
355 If the driver offers user-configurable VLAN support, disable
356 reception of extended frames or tag processing in hardware,
358 .It Cm pollcpu Ar cpu
361 feature and disable interrupts on the interface,
362 if the driver supports this mode and
366 Driver will be polled by
371 feature and disable interrupts on the interface, if the driver supports
376 feature and enable interrupt mode on the interface.
378 Create the specified network pseudo-device.
379 If the interface is given without a unit number, try to create a new
380 device with an arbitrary unit number.
381 If creation of an arbitrary device is successful, the new device name is
382 printed to standard output unless the interface is renamed or destroyed
387 Destroy the specified network pseudo-device.
403 Set the routing metric of the interface to
406 The routing metric is used by the routing protocol
408 Higher metrics have the effect of making a route
409 less favorable; metrics are counted as additional hops
410 to the destination network or host.
412 Set the maximum transmission unit of the interface to
414 default is interface specific.
415 The MTU is used to limit the size of packets that are transmitted on an
417 Not all interfaces support setting the MTU, and some interfaces have
419 .It Cm netmask Ar mask
422 Specify how much of the address to reserve for subdividing
423 networks into sub-networks.
424 The mask includes the network part of the local address
425 and the subnet part, which is taken from the host field of the address.
426 The mask can be specified as a single hexadecimal number
429 with a dot-notation Internet address,
430 or with a pseudo-network name listed in the network table
432 The mask contains 1's for the bit positions in the 32-bit address
433 which are to be used for the network and subnet parts,
434 and 0's for the host part.
435 The mask should contain at least the standard network portion,
436 and the subnet field should be contiguous with the network
439 The netmask can also be specified in CIDR notation after the address.
442 option above for more information.
445 Enable autoconfiguration.
447 Disable autoconfiguration.
450 Set preferred lifetime for the address.
453 Set valid lifetime for the address.
454 .It Cm prefixlen Ar len
458 bits are reserved for subdividing networks into sub-networks.
461 must be integer, and for syntactical reason it must be between 0 to 128.
462 It is almost always 64 under the current IPv6 assignment rule.
463 If the parameter is omitted, 64 is used.
465 The prefix can also be specified using the slash notation after the address.
468 option above for more information.
471 Set the IPv6 deprecated address bit.
474 Clear the IPv6 deprecated address bit.
477 Set the IPv6 tentative address bit.
480 Clear the IPv6 tentative address bit.
483 .\" .It Cm nsellength Ar n
486 .\" This specifies a trailing number of bytes for a received
488 .\" used for local identification, the remaining leading part of which is
491 .\" (Network Entity Title).
492 .\" The default value is 1, which is conformant to US
494 .\" When an ISO address is set in an ifconfig command,
497 .\" which is being specified.
500 .\" 20 hex digits should be
503 .\" to be assigned to the interface.
504 .\" There is some evidence that a number different from 1 may be useful
507 .\" 37 type addresses.
508 .It Cm range Ar netrange
509 Under appletalk, set the interface to respond to a
512 .Ar startnet Ns - Ns Ar endnet .
513 Appletalk uses this scheme instead of
516 implements it internally as a set of netmasks.
521 Introduced for compatibility
525 The argument following this specifies the version (phase) of the
526 Appletalk network attached to the interface.
527 Values of 1 or 2 are permitted.
529 .It Cm link Op Cm 0 No - Cm 2
531 Enable special processing of the link level of the interface.
532 These three options are interface specific in actual effect, however,
533 they are in general used to select special modes of operation.
535 of this is to enable SLIP compression, or to select the connector type
536 for some Ethernet cards.
537 Refer to the man page for the specific driver
538 for more information.
540 .It Fl link Op Cm 0 No - Cm 2
542 Disable special processing at the link level with the specified interface.
556 Put the interface in monitor mode.
557 No packets are transmitted, and received packets are discarded after
561 Take the interface out of monitor mode.
565 This may be used to enable an interface after an
567 It happens automatically when setting the first address on an interface.
568 If the interface was reset when previously marked down,
569 the hardware will be re-initialized.
572 The following parameters are specific to cloning
573 IEEE 802.11 wireless interfaces with the
576 .Bl -tag -width indent
577 .It Cm wlandev Ar device
580 as the parent for the cloned device.
581 .It Cm wlanmode Ar mode
582 Specify the operating mode for this cloned device.
600 The operating mode of a cloned interface cannot be changed.
603 mode is actually implemented as an
605 interface with special properties.
606 .It Cm wlanbssid Ar bssid
607 The 802.11 mac address to use for the bssid.
608 This must be specified at create time for a legacy
611 .It Cm wlanaddr Ar address
612 The local mac address.
613 If this is not specified then a mac address will automatically be assigned
614 to the cloned device.
615 Typically this address is the same as the address of the parent device
618 parameter is specified then the driver will craft a unique address for
619 the device (if supported).
623 device as operating in ``legacy mode''.
626 devices have a fixed peer relationship and do not, for example, roam
627 if their peer stops communicating.
628 For completeness a Dynamic WDS (DWDS) interface may marked as
631 Request a unique local mac address for the cloned device.
632 This is only possible if the device supports multiple mac addresses.
633 To force use of the parent's mac address use
636 Mark the cloned interface as depending on hardware support to
637 track received beacons.
638 To have beacons tracked in software use
644 can also be used to indicate no beacons should
645 be transmitted; this can be useful when creating a WDS configuration but
647 interfaces can only be created as companions to an access point.
650 The following parameters are specific to IEEE 802.11 wireless interfaces
654 .Bl -tag -width indent
656 Enable sending and receiving AMPDU frames when using 802.11n (default).
657 The 802.11n specification states a compliant station must be capable
658 of receiving AMPDU frames but transmision is optional.
661 to disable all use of AMPDU with 802.11n.
662 For testing and/or to work around interoperability problems one can use
666 to control use of AMPDU in one direction.
667 .It Cm ampdudensity Ar density
668 Set the AMPDU density parameter used when operating with 802.11n.
669 This parameter controls the inter-packet gap for AMPDU frames.
670 The sending device normally controls this setting but a receiving station
671 may request wider gaps.
674 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
677 is treated the same as 0.
678 .It Cm ampdulimit Ar limit
679 Set the limit on packet size for receiving AMPDU frames when operating
683 are 8192, 16384, 32768, and 65536 but one can also specify
684 just the unique prefix: 8, 16, 32, 64.
685 Note the sender may limit the size of AMPDU frames to be less
686 than the maximum specified by the receiving station.
688 Enable sending and receiving AMSDU frames when using 802.11n.
689 By default AMSDU is received but not transmitted.
692 to disable all use of AMSDU with 802.11n.
693 For testing and/or to work around interoperability problems one can use
697 to control use of AMSDU in one direction.
698 .It Cm amsdulimit Ar limit
699 Set the limit on packet size for sending and receiving AMSDU frames
700 when operating with 802.11n.
703 are 7935 and 3839 (bytes).
704 Note the sender may limit the size of AMSDU frames to be less
705 than the maximum specified by the receiving station.
706 Note also that devices are not required to support the 7935 limit,
707 only 3839 is required by the specification and the larger value
708 may require more memory to be dedicated to support functionality
711 When operating as an access point, pass packets between
712 wireless clients directly (default).
713 To instead let them pass up through the
714 system and be forwarded using some other mechanism, use
716 Disabling the internal bridging
717 is useful when traffic is to be processed with
719 .It Cm authmode Ar mode
720 Set the desired authentication mode in infrastructure mode.
721 Not all adapters support all modes.
724 .Cm none , open , shared
730 (IEEE WPA/WPA2/802.11i).
735 modes are only useful when using an authentication service
736 (a supplicant for client operation or an authenticator when
737 operating as an access point).
738 Modes are case insensitive.
740 Enable background scanning when operating as a station.
741 Background scanning is a technique whereby a station associated to
742 an access point will temporarily leave the channel to scan for
743 neighboring stations.
744 This allows a station to maintain a cache of nearby access points
745 so that roaming between access points can be done without
746 a lengthy scan operation.
747 Background scanning is done only when a station is not busy and
748 any outbound traffic will cancel a scan operation.
749 Background scanning should never cause packets to be lost though
750 there may be some small latency if outbound traffic interrupts a
752 By default background scanning is enabled if the device is capable.
753 To disable background scanning, use
755 Background scanning is controlled by the
760 Background scanning must be enabled for roaming; this is an artifact
761 of the current implementation and may not be required in the future.
762 .It Cm bgscanidle Ar idletime
763 Set the minimum time a station must be idle (not transmitting or
764 receiving frames) before a background scan is initiated.
767 parameter is specified in milliseconds.
768 By default a station must be idle at least 250 milliseconds before
769 a background scan is initiated.
770 The idle time may not be set to less than 100 milliseconds.
771 .It Cm bgscanintvl Ar interval
772 Set the interval at which background scanning is attempted.
775 parameter is specified in seconds.
776 By default a background scan is considered every 300 seconds (5 minutes).
779 may not be set to less than 15 seconds.
780 .It Cm bintval Ar interval
781 Set the interval at which beacon frames are sent when operating in
785 parameter is specified in TU's (1024 usecs).
786 By default beacon frames are transmitted every 100 TU's.
787 .It Cm bmissthreshold Ar count
788 Set the number of consecutive missed beacons at which the station
789 will attempt to roam (i.e., search for a new access point).
792 parameter must be in the range 1 to 255; though the
793 upper bound may be reduced according to device capabilities.
794 The default threshold is 7 consecutive missed beacons; but
795 this may be overridden by the device driver.
800 .It Cm bssid Ar address
801 Specify the MAC address of the access point to use when operating
802 as a station in a BSS network.
803 This overrides any automatic selection done by the system.
804 To disable a previously selected access point, supply
809 This option is useful when more than one access point uses the same SSID.
815 Enable packet bursting.
816 Packet bursting is a transmission technique whereby the wireless
817 medium is acquired once to send multiple frames and the interframe
819 This technique can significantly increase throughput by reducing
820 transmission overhead.
821 Packet bursting is supported by the 802.11e QoS specification
822 and some devices that do not support QoS may still be capable.
823 By default packet bursting is enabled if a device is capable
825 To disable packet bursting, use
827 .It Cm chanlist Ar channels
828 Set the desired channels to use when scanning for access
829 points, neighbors in an IBSS network, or looking for unoccupied
830 channels when operating as an access point.
831 The set of channels is specified as a comma-separated list with
832 each element in the list representing either a single channel number or a range
835 Channel numbers must be in the range 1 to 255 and be permissible
836 according to the operating characteristics of the device.
837 .It Cm channel Ar number
838 Set a single desired channel.
839 Channels range from 1 to 255, but the exact selection available
840 depends on the region your adaptor was manufactured for.
846 will clear any desired channel and, if the device is marked up,
847 force a scan for a channel to operate on.
848 Alternatively the frequency, in megahertz, may be specified
849 instead of the channel number.
851 When there are several ways to use a channel the channel
852 number/frequency may be appended with attributes to clarify.
853 For example, if a device is capable of operating on channel 6
854 with 802.11n and 802.11g then one can specify that g-only use
855 should be used by specifying ``6:g''.
856 Similarly the channel width can be specified by appending it
857 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
858 These attributes can be combined as in: ``6:ht/40''.
859 The full set of flags specified following a `:'' are:
865 (Atheros Dynamic Turbo mode),
873 (Atheros Static Turbo mode),
876 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
877 The full set of channel widths following a '/' are:
879 (5MHz aka quarter-rate channel),
881 (10MHz aka half-rate channel),
883 (20MHz mostly for use in specifying ht20),
886 (40MHz mostly for use in specifying ht40),
888 a 40MHz HT channel specification may include the location
889 of the extension channel by appending ``+'' or ``-'' for above and below,
890 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
891 with the center channel at frequency 2437 and the extension channel above.
892 .It Cm country Ar name
893 Set the country code to use in calculating the regulatory constraints
895 In particular the set of available channels, how the wireless device
896 will operation on the channels, and the maximum transmit power that
897 can be used on a channel are defined by this setting.
898 Country/Region codes are specified as a 2-character abbreviation
899 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
900 e.g. "ES" and "Spain".
901 The set of country codes are taken from /etc/regdomain.xml and can also
902 be viewed with the ``list countries'' request.
903 Note that not all devices support changing the country code from a default
904 setting; typically stored in EEPROM.
912 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
913 DFS embodies several facilities including detection of overlapping
914 radar signals, dynamic transmit power control, and channel selection
915 according to a least-congested criteria.
916 DFS support is mandatory for some 5Ghz frequencies in certain
918 By default DFS is enabled according to the regulatory definitions
919 specified in /etc/regdomain.xml and the curent country code, regdomain,
921 Note the underlying device (and driver) must support radar detection
922 for full DFS support to work.
923 To be fully compliant with the local regulatory agency frequencies that
924 require DFS should not be used unless it is fully supported.
927 to disable this functionality for testing.
929 Enable support for the 802.11d specification (default).
930 When this support is enabled in station mode, beacon frames that advertise
931 a country code different than the currently configured country code will
932 cause an event to be dispatched to user applications.
933 This event can be used by the station to adopt that country code and
934 operate according to the associated regulatory constraints.
935 When operating as an access point with 802.11d enabled the beacon and
936 probe response frames transmitted will advertise the current regulatory
938 To disable 802.11d use
941 Enable 802.11h support including spectrum management.
942 When 802.11h is enabled beacon and probe response frames will have
943 the SpectrumMgt bit set in the capabilities field and
944 country and power constraint information elements will be present.
945 802.11h support also includes handling Channel Switch Announcements (CSA)
946 which are a mechanism to coordinate channel changes by an access point.
947 By default 802.11h is enabled if the device is capable.
948 To disable 802.11h use
950 .It Cm deftxkey Ar index
951 Set the default key to use for transmission.
952 Typically this is only set when using WEP encryption.
953 Note that you must set a default transmit key
954 for the system to know which key to use in encrypting outbound traffic.
957 is an alias for this request; it is provided for backwards compatibility.
958 .It Cm dtimperiod Ar period
961 period for transmitting buffered multicast data frames when
962 operating in ap mode.
965 specifies the number of beacon intervals between DTIM
966 and must be in the range 1 to 15.
967 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
969 Enable the use of Atheros Dynamic Turbo mode when communicating with
970 another Dynamic Turbo-capable station.
971 Dynamic Turbo mode is an Atheros-specific mechanism by which
972 stations switch between normal 802.11 operation and a ``boosted''
973 mode in which a 40MHz wide channel is used for communication.
974 Stations using Dynamic Turbo mode operate boosted only when the
975 channel is free of non-dturbo stations; when a non-dturbo station
976 is identified on the channel all stations will automatically drop
977 back to normal operation.
978 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
979 Note that turbo mode (dynamic or static) is only allowed on some
980 channels depending on the regulatory constraints; use the
982 command to identify the channels where turbo mode may be used.
983 To disable Dynamic Turbo mode use
986 Enable Dynamic WDS (DWDS) support.
987 DWDS is a facility by which 4-address traffic can be carried between
988 stations operating in infrastructure mode.
989 A station first associates to an access point and authenticates using
990 normal procedures (e.g. WPA).
991 Then 4-address frames are passed to carry traffic for stations
992 operating on either side of the wireless link.
993 DWDS extends the normal WDS mechanism by leveraging existing security
994 protocols and eliminating static binding.
996 When DWDS is enabled on an access point 4-address frames received from
997 an authorized station will generate a ``DWDS discovery'' event to user
999 This event should be used to create a WDS interface that is bound
1000 to the remote station (and usually plumbed into a bridge).
1001 Once the WDS interface is up and running 4-address traffic then logically
1002 flows through that interface.
1004 When DWDS is enabled on a station, traffic with a destination address
1005 different from the peer station are encapsulated in a 4-address frame
1006 and transmitted to the peer.
1007 All 4-address traffic uses the security information of the stations
1008 (e.g. cryptographic keys).
1009 A station is associated using 802.11n facilities may transport
1010 4-address traffic using these same mechanisms; this depends on available
1011 resources and capabilities of the device.
1012 The DWDS implementation guards against layer 2 routing loops of
1015 Enable the use of Atheros Fast Frames when communicating with
1016 another Fast Frames-capable station.
1017 Fast Frames are an encapsulation technique by which two 802.3
1018 frames are transmitted in a single 802.11 frame.
1019 This can noticeably improve throughput but requires that the
1020 receiving station understand how to decapsulate the frame.
1021 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1022 protocol extension so enabling use is safe when communicating with
1023 non-Atheros devices.
1024 By default, use of fast frames is enabled if the device is capable.
1025 To explicitly disable fast frames, use
1027 .It Cm fragthreshold Ar length
1028 Set the threshold for which transmitted frames are broken into fragments.
1031 argument is the frame size in bytes and must be in the range 256 to 2346.
1039 disables transmit fragmentation.
1040 Not all adapters honor the fragmentation threshold.
1042 When operating as an access point, do not broadcast the SSID
1043 in beacon frames or respond to probe request frames unless
1044 they are directed to the ap (i.e., they include the ap's SSID).
1045 By default, the SSID is included in beacon frames and
1046 undirected probe request frames are answered.
1047 To re-enable the broadcast of the SSID etc., use
1050 Enable use of High Throughput (HT) when using 802.11n (default).
1051 The 802.11n specification includes mechanisms for operation
1052 on 20MHz and 40MHz wide channels using different signalling mechanisms
1053 than specified in 802.11b, 802.11g, and 802.11a.
1054 Stations negotiate use of these facilities, termed HT20 and HT40,
1055 when they associate.
1056 To disable all use of 802.11n use
1058 To disable use of HT20 (e.g. to force only HT40 use) use
1060 To disable use of HT40 use
1063 HT configuration is used to ``auto promote'' operation
1064 when several choices are available.
1065 For example, if a station associates to an 11n-capable access point
1066 it controls whether the station uses legacy operation, HT20, or HT40.
1067 When an 11n-capable device is setup as an access point and
1068 Auto Channel Selection is used to locate a channel to operate on,
1069 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1070 on the selected channel.
1071 If a fixed channel is specified for a station then HT configuration can
1072 be given as part of the channel specification; e.g. 6:ht/20 to setup
1073 HT20 operation on channel 6.
1075 Enable use of compatibility support for pre-802.11n devices (default).
1076 The 802.11n protocol specification went through several incompatible iterations.
1077 Some vendors implemented 11n support to older specifications that
1078 will not interoperate with a purely 11n-compliant station.
1079 In particular the information elements included in management frames
1080 for old devices are different.
1081 When compatibility support is enabled both standard and compatible data
1083 Stations that associate using the compatibility mechanisms are flagged
1085 To disable compatibility support use
1087 .It Cm htprotmode Ar technique
1088 For interfaces operating in 802.11n, use the specified
1090 for protecting HT frames in a mixed legacy/HT network.
1091 The set of valid techniques is
1096 Technique names are case insensitive.
1098 Enable inactivity processing for stations associated to an
1099 access point (default).
1100 When operating as an access point the 802.11 layer monitors
1101 the activity of each associated station.
1102 When a station is inactive for 5 minutes it will send several
1103 ``probe frames'' to see if the station is still present.
1104 If no response is received then the station is deauthenticated.
1105 Applications that prefer to handle this work can disable this
1109 Set the location to use in calculating regulatory constraints.
1110 The location is also advertised in beacon and probe response frames
1111 when 802.11d is enabled with
1120 Display the list of channels available for use taking into account
1121 any restrictions set with the
1124 See the description of
1126 for more information.
1128 Display the adaptor's capabilities, including the operating
1131 Display the list of channels available for use.
1132 Channels are shown with their IEEE channel number, equivalent
1133 frequency, and usage modes.
1134 Channels identified as
1139 Channels identified as
1141 may be used only for Atheros' Static Turbo mode
1143 .Cm mediaopt turbo ) .
1144 Channels marked with a
1146 have a regulatory constraint that they be passively scanned.
1147 This means a station is not permitted to transmit on the channel until
1148 it identifies the channel is being used for 802.11 communication;
1149 typically by hearing a beacon frame from an access point operating
1152 is another way of requesting this information.
1153 By default a compacted list of channels is displayed; if the
1155 option is specified then all channels are shown.
1156 .It Cm list countries
1157 Display the set of country codes and regulatory domains that can be
1158 used in regulatory configuration.
1160 Display the current MAC Access Control List state.
1161 Each address is prefixed with a character that indicates the
1162 current policy applied to it:
1164 indicates the address is allowed access,
1166 indicates the address is denied access,
1168 indicates the address is present but the current policy open
1169 (so the ACL is not consulted).
1171 Displays the mesh routing table, used for forwarding packets on a mesh
1173 .It Cm list regdomain
1174 Display the current regulatory settings including the available channels
1175 and transmit power caps.
1177 Display the parameters that govern roaming operation.
1179 Display the parameters that govern transmit operation.
1181 Display the transmit power caps for each channel.
1183 Display the access points and/or ad-hoc neighbors
1184 located in the vicinity.
1185 This information may be updated automatically by the adapter
1188 request or through background scanning.
1189 Depending on the capabilities of the stations the following
1190 flags can be included in the output:
1194 Indicates that the station is permitted to send/receive data frames.
1196 Extended Rate Phy (ERP).
1197 Indicates that the station is operating in an 802.11g network
1198 using extended transmit rates.
1200 High Throughput (HT).
1201 Indicates that the station is using HT transmit rates.
1202 If a `+' follows immediately after then the station associated
1203 using deprecated mechanisms supported only when
1208 Indicates that the station is operating in power save mode.
1210 Quality of Service (QoS).
1211 Indicates that the station is using QoS encapsulation for
1213 QoS encapsulation is enabled only when WME mode is enabled.
1215 Transitional Security Network (TSN).
1216 Indicates that the station associated using TSN; see also
1220 Wi-Fi Protected Setup (WPS).
1221 Indicates that the station associated using WPS.
1224 By default interesting information elements captured from the neighboring
1225 stations are displayed at the end of each row.
1226 Possible elements include:
1228 (station supports WME),
1230 (station supports WPA),
1232 (station supports WPS),
1234 (station supports 802.11i/RSN),
1236 (station supports 802.11n/HT communication),
1238 (station supports Atheros protocol extensions),
1240 (station supports unknown vendor-specific extensions).
1243 flag is used all the information elements and their
1244 contents will be shown.
1247 flag also enables display of long SSIDs.
1250 command is another way of requesting this information.
1252 When operating as an access point display the stations that are
1253 currently associated.
1254 When operating in ad-hoc mode display stations identified as
1255 neighbors in the IBSS.
1256 When operating in mesh mode display stations identified as
1257 neighbors in the MBSS.
1258 When operating in station mode display the access point.
1259 Capabilities advertised by the stations are described under
1263 Depending on the capabilities of the stations the following
1264 flags can be included in the output:
1268 Indicates that the station is permitted to send/receive data frames.
1270 Extended Rate Phy (ERP).
1271 Indicates that the station is operating in an 802.11g network
1272 using extended transmit rates.
1274 High Throughput (HT).
1275 Indicates that the station is using HT transmit rates.
1276 If a `+' follows immediately after then the station associated
1277 using deprecated mechanisms supported only when
1282 Indicates that the station is operating in power save mode.
1284 Quality of Service (QoS).
1285 Indicates that the station is using QoS encapsulation for
1287 QoS encapsulation is enabled only when WME mode is enabled.
1289 Transitional Security Network (TSN).
1290 Indicates that the station associated using TSN; see also
1294 Wi-Fi Protected Setup (WPS).
1295 Indicates that the station associated using WPS.
1298 By default information elements received from associated stations
1299 are displayed in a short form; the
1301 flag causes this information to be displayed symbolically.
1303 Display the current channel parameters to use when operating in WME mode.
1306 option is specified then both channel and BSS parameters are displayed
1307 for each AC (first channel, then BSS).
1308 When WME mode is enabled for an adaptor this information will be
1309 displayed with the regular status; this command is mostly useful
1310 for examining parameters when WME mode is disabled.
1311 See the description of the
1313 directive for information on the various parameters.
1314 .It Cm maxretry Ar count
1315 Set the maximum number of tries to use in sending unicast frames.
1316 The default setting is 6 but drivers may override this with a value
1318 .It Cm mcastrate Ar rate
1319 Set the rate for transmitting multicast/broadcast frames.
1320 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1321 This rate should be valid for the current operating conditions;
1322 if an invalid rate is specified drivers are free to chose an
1324 .It Cm mgtrate Ar rate
1325 Set the rate for transmitting management and/or control frames.
1326 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1328 Set the location to use in calculating regulatory constraints.
1329 The location is also advertised in beacon and probe response frames
1330 when 802.11d is enabled with
1339 Enable powersave operation.
1340 When operating as a client, the station will conserve power by
1341 periodically turning off the radio and listening for
1342 messages from the access point telling it there are packets waiting.
1343 The station must then retrieve the packets.
1344 Not all devices support power save operation as a client.
1345 The 802.11 specification requires that all access points support
1346 power save but some drivers do not.
1349 to disable powersave operation when operating as a client.
1350 .It Cm powersavemode Ar mode
1352 The set of valid modes is
1363 .It Cm powersavesleep Ar sleep
1364 Set the desired max powersave sleep time in TU's (1024 usecs).
1365 By default the max powersave sleep time is 100 TU's.
1366 .It Cm protmode Ar technique
1367 For interfaces operating in 802.11g, use the specified
1369 for protecting OFDM frames in a mixed 11b/11g network.
1370 The set of valid techniques is
1376 Technique names are case insensitive.
1377 Not all devices support
1379 as a protection technique.
1381 When operating as an access point in 802.11g mode allow only
1382 11g-capable stations to associate (11b-only stations are not
1383 permitted to associate).
1384 To allow both 11g and 11b-only stations to associate, use
1387 When operating as an access point in 802.11n mode allow only
1388 HT-capable stations to associate (legacy stations are not
1389 permitted to associate).
1390 To allow both HT and legacy stations to associate, use
1392 .It Cm regdomain Ar sku
1393 Set the regulatory domain to use in calculating the regulatory constraints
1395 In particular the set of available channels, how the wireless device
1396 will operation on the channels, and the maximum transmit power that
1397 can be used on a channel are defined by this setting.
1398 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1399 be viewed with the ``list countries'' request.
1400 Note that not all devices support changing the regdomain from a default
1401 setting; typically stored in EEPROM.
1409 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1411 Note that RIFS must be supported by both the station and access point
1415 .It Cm roam:rate Ar rate
1416 Set the threshold for controlling roaming when operating in a BSS.
1419 parameter specifies the transmit rate in megabits
1420 at which roaming should be considered.
1421 If the current transmit rate drops below this setting and background scanning
1422 is enabled, then the system will check if a more desirable access point is
1423 available and switch over to it.
1424 The current scan cache contents are used if they are considered
1425 valid according to the
1427 parameter; otherwise a background scan operation is triggered before
1428 any selection occurs.
1429 Each channel type has a separate rate threshold; the default values are:
1430 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1431 .It Cm roam:rssi Ar rssi
1432 Set the threshold for controlling roaming when operating in a BSS.
1435 parameter specifies the receive signal strength in dBm units
1436 at which roaming should be considered.
1437 If the current rssi 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 rssi threshold; the default values are
1447 .It Cm roaming Ar mode
1448 When operating as a station, control how the system will
1449 behave when communication with the current access point
1453 argument may be one of
1455 (leave it to the hardware device to decide),
1457 (handle either in the device or the operating system\[em]as appropriate),
1459 (do nothing until explicitly instructed).
1460 By default, the device is left to handle this if it is
1461 capable; otherwise, the operating system will automatically
1462 attempt to reestablish communication.
1463 Manual mode is used by applications such as
1464 .Xr wpa_supplicant 8
1465 that want to control the selection of an access point.
1466 .It Cm rtsthreshold Ar length
1467 Set the threshold for which
1468 transmitted frames are preceded by transmission of an
1474 is the frame size in bytes and must be in the range 1 to 2346.
1482 disables transmission of RTS frames.
1483 Not all adapters support setting the RTS threshold.
1485 Initiate a scan of neighboring stations, wait for it to complete, and
1486 display all stations found.
1487 Only the super-user can initiate a scan.
1490 for information on the display.
1491 By default a background scan is done; otherwise a foreground
1492 scan is done and the station may roam to a different access point.
1495 request can be used to show recent scan results without
1496 initiating a new scan.
1497 .It Cm scanvalid Ar threshold
1498 Set the maximum time the scan cache contents are considered valid;
1499 i.e. will be used without first triggering a scan operation to
1503 parameter is specified in seconds and defaults to 60 seconds.
1504 The minimum setting for
1507 One should take care setting this threshold; if it is set too low
1508 then attempts to roam to another access point may trigger unnecessary
1509 background scan operations.
1511 Enable use of Short Guard Interval when operating in 802.11n
1513 NB: this currently enables Short GI on both HT40 and HT20 channels.
1514 To disable Short GI use
1517 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1518 when operating in 802.11n.
1519 A station operating with Static SMPS maintains only a single
1520 receive chain active (this can significantly reduce power consumption).
1524 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1525 when operating in 802.11n.
1526 A station operating with Dynamic SMPS maintains only a single
1527 receive chain active but switches to multiple receive chains when it
1528 receives an RTS frame (this can significantly reduce power consumption).
1529 Note that stations cannot distinguish between RTS/CTS intended to
1530 enable multiple receive chains and those used for other purposes.
1534 Set the desired Service Set Identifier (aka network name).
1535 The SSID is a string up to 32 characters
1536 in length and may be specified as either a normal string or in
1537 hexadecimal when preceded by
1539 Additionally, the SSID may be cleared by setting it to
1541 .It Cm tdmaslot Ar slot
1542 When operating with TDMA, use the specified
1547 is a number between 0 and the maximum number of slots in the BSS.
1548 Note that a station configured as slot 0 is a master and
1549 will broadcast beacon frames advertising the BSS;
1550 stations configured to use other slots will always
1551 scan to locate a master before they ever transmit.
1555 .It Cm tdmaslotcnt Ar cnt
1556 When operating with TDMA, setup a BSS with
1559 The slot count may be at most 8.
1560 The current implementation is only tested with two stations
1561 (i.e. point to point applications).
1562 This setting is only meaningful when a station is configured as slot 0;
1563 other stations adopt this setting from the BSS they join.
1567 .It Cm tdmaslotlen Ar len
1568 When operating with TDMA, setup a BSS such that each station has a slot
1571 The slot length must be at least 150 microseconds (1/8 TU)
1572 and no more than 65 milliseconds.
1573 Note that setting too small a slot length may result in poor channel
1574 bandwidth utilization due to factors such as timer granularity and
1576 This setting is only meaningful when a station is configured as slot 0;
1577 other stations adopt this setting from the BSS they join.
1580 is set to 10 milliseconds.
1581 .It Cm tdmabintval Ar intval
1582 When operating with TDMA, setup a BSS such that beacons are transmitted every
1584 superframes to synchronize the TDMA slot timing.
1585 A superframe is defined as the number of slots times the slot length; e.g.
1586 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1587 The beacon interval may not be zero.
1590 causes the timers to be resynchronized more often; this can be help if
1591 significant timer drift is observed.
1596 When operating as an access point with WPA/802.11i allow legacy
1597 stations to associate using static key WEP and open authentication.
1598 To disallow legacy station use of WEP, use
1600 .It Cm txpower Ar power
1601 Set the power used to transmit frames.
1604 argument is specified in .5 dBm units.
1605 Out of range values are truncated.
1606 Typically only a few discreet power settings are available and
1607 the driver will use the setting closest to the specified value.
1608 Not all adapters support changing the transmit power.
1609 .It Cm ucastrate Ar rate
1610 Set a fixed rate for transmitting unicast frames.
1611 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1612 This rate should be valid for the current operating conditions;
1613 if an invalid rate is specified drivers are free to chose an
1615 .It Cm wepmode Ar mode
1616 Set the desired WEP mode.
1617 Not all adapters support all modes.
1618 The set of valid modes is
1624 mode explicitly tells the adaptor to allow association with access
1625 points which allow both encrypted and unencrypted traffic.
1628 means that the access point must only allow encrypted connections.
1631 is generally another name for
1633 Modes are case insensitive.
1634 .It Cm weptxkey Ar index
1635 Set the WEP key to be used for transmission.
1636 This is the same as setting the default transmission key with
1638 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1639 Set the selected WEP key.
1642 is not given, key 1 is set.
1643 A WEP key will be either 5 or 13
1644 characters (40 or 104 bits) depending of the local network and the
1645 capabilities of the adaptor.
1646 It may be specified either as a plain
1647 string or as a string of hexadecimal digits preceded by
1649 For maximum portability, hex keys are recommended;
1650 the mapping of text keys to WEP encryption is usually driver-specific.
1653 drivers do this mapping differently to
1655 A key may be cleared by setting it to
1657 If WEP is supported then there are at least four keys.
1658 Some adapters support more than four keys.
1659 If that is the case, then the first four keys
1660 (1-4) will be the standard temporary keys and any others will be adaptor
1661 specific keys such as permanent keys stored in NVRAM.
1663 Note that you must set a default transmit key with
1665 for the system to know which key to use in encrypting outbound traffic.
1667 Enable Wireless Multimedia Extensions (WME) support, if available,
1668 for the specified interface.
1669 WME is a subset of the IEEE 802.11e standard to support the
1670 efficient communication of realtime and multimedia data.
1671 To disable WME support, use
1673 Another name for this parameter is
1676 The following parameters are meaningful only when WME support is in use.
1677 Parameters are specified per-AC (Access Category) and
1678 split into those that are used by a station when acting
1679 as an access point and those for client stations in the BSS.
1680 The latter are received from the access point and may not be changed
1682 The following Access Categories are recognized:
1684 .Bl -tag -width ".Cm AC_BK" -compact
1688 best effort delivery,
1703 AC parameters are case-insensitive.
1704 Traffic classification is done in the operating system using the
1705 vlan priority associated with data frames or the
1706 ToS (Type of Service) indication in IP-encapsulated frames.
1707 If neither information is present, traffic is assigned to the
1708 Best Effort (BE) category.
1709 .Bl -tag -width indent
1711 Set the ACK policy for QoS transmissions by the local station;
1712 this controls whether or not data frames transmitted by a station
1713 require an ACK response from the receiving station.
1714 To disable waiting for an ACK use
1716 This parameter is applied only to the local station.
1718 Enable the Admission Control Mandatory (ACM) mechanism
1719 for transmissions by the local station.
1720 To disable the ACM use
1722 On stations in a BSS this parameter is read-only and indicates
1723 the setting received from the access point.
1724 NB: ACM is not supported right now.
1725 .It Cm aifs Ar ac Ar count
1726 Set the Arbitration Inter Frame Spacing (AIFS)
1727 channel access parameter to use for transmissions
1728 by the local station.
1729 On stations in a BSS this parameter is read-only and indicates
1730 the setting received from the access point.
1731 .It Cm cwmin Ar ac Ar count
1732 Set the CWmin channel access parameter to use for transmissions
1733 by the local station.
1734 On stations in a BSS this parameter is read-only and indicates
1735 the setting received from the access point.
1736 .It Cm cwmax Ar ac Ar count
1737 Set the CWmax channel access parameter to use for transmissions
1738 by the local station.
1739 On stations in a BSS this parameter is read-only and indicates
1740 the setting received from the access point.
1741 .It Cm txoplimit Ar ac Ar limit
1742 Set the Transmission Opportunity Limit channel access parameter
1743 to use for transmissions by the local station.
1744 This parameter defines an interval of time when a WME station
1745 has the right to initiate transmissions onto the wireless medium.
1746 On stations in a BSS this parameter is read-only and indicates
1747 the setting received from the access point.
1748 .It Cm bss:aifs Ar ac Ar count
1749 Set the AIFS channel access parameter to send to stations in a BSS.
1750 This parameter is meaningful only when operating in ap mode.
1751 .It Cm bss:cwmin Ar ac Ar count
1752 Set the CWmin channel access parameter to send to stations in a BSS.
1753 This parameter is meaningful only when operating in ap mode.
1754 .It Cm bss:cwmax Ar ac Ar count
1755 Set the CWmax channel access parameter to send to stations in a BSS.
1756 This parameter is meaningful only when operating in ap mode.
1757 .It Cm bss:txoplimit Ar ac Ar limit
1758 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1759 This parameter is meaningful only when operating in ap mode.
1762 Enable Wireless Privacy Subscriber support.
1763 Note that WPS support requires a WPS-capable supplicant.
1764 To disable this function use
1768 The following parameters support an optional access control list
1769 feature available with some adapters when operating in ap mode; see
1771 This facility allows an access point to accept/deny association
1772 requests based on the MAC address of the station.
1773 Note that this feature does not significantly enhance security
1774 as MAC address spoofing is easy to do.
1775 .Bl -tag -width indent
1776 .It Cm mac:add Ar address
1777 Add the specified MAC address to the database.
1778 Depending on the policy setting association requests from the
1779 specified station will be allowed or denied.
1781 Set the ACL policy to permit association only by
1782 stations registered in the database.
1783 .It Cm mac:del Ar address
1784 Delete the specified MAC address from the database.
1786 Set the ACL policy to deny association only by
1787 stations registered in the database.
1788 .It Cm mac:kick Ar address
1789 Force the specified station to be deauthenticated.
1790 This typically is done to block a station after updating the
1793 Set the ACL policy to allow all stations to associate.
1795 Delete all entries in the database.
1797 Set the ACL policy to permit association only by
1798 stations approved by a RADIUS server.
1799 Note that this feature requires the
1801 program be configured to do the right thing
1802 as it handles the RADIUS processing
1803 (and marks stations as authorized).
1806 The following parameters are related to a wireless interface operating in mesh
1808 .Bl -tag -width indent
1809 .It Cm meshid Ar meshid
1810 Set the desired Mesh Identifier.
1811 The Mesh ID is a string up to 32 characters in length.
1812 A mesh interface must have a Mesh Identifier specified
1813 to reach an operational state.
1814 .It Cm meshttl Ar ttl
1815 Set the desired ``time to live'' for mesh forwarded packets;
1816 this is the number of hops a packet may be forwarded before
1818 The default setting for
1822 Enable or disable peering with neighbor mesh stations.
1823 Stations must peer before any data packets can be exchanged.
1828 Enable or disable forwarding packets by a mesh interface.
1832 .It Cm meshmetric Ar protocol
1835 as the link metric protocol used on a mesh network.
1836 The default protocol is called
1838 The mesh interface will restart after changing this setting.
1839 .It Cm meshpath Ar protocol
1842 as the path selection protocol used on a mesh network.
1843 The only available protocol at the moment is called
1845 (Hybrid Wireless Mesh Protocol).
1846 The mesh interface will restart after changing this setting.
1847 .It Cm hwmprootmode Ar mode
1848 Stations on a mesh network can operate as ``root nodes.''
1849 Root nodes try to find paths to all mesh nodes and advertise themselves
1851 When there is a root mesh node on a network, other mesh nodes can setup
1852 paths between themselves faster because they can use the root node
1853 to find the destination.
1854 This path may not be the best, but on-demand
1855 routing will eventually find the best path.
1856 The following modes are recognized:
1858 .Bl -tag -width ".Cm PROACTIVE" -compact
1862 Send broadcast path requests every two seconds.
1863 Nodes on the mesh without a path to this root mesh station with try to
1864 discover a path to us.
1866 Send broadcast path requests every two seconds and every node must reply
1867 with a path reply even if it already has a path to this root mesh station,
1869 Send broadcast root annoucement (RANN) frames.
1870 Nodes on the mesh without a path to this root mesh station with try to
1871 discover a path to us.
1877 .It Cm hwmpmaxhops Ar cnt
1878 Set the maximum number of hops allowed in an HMWP path to
1880 The default setting for
1885 The following parameters are for compatibility with other systems:
1886 .Bl -tag -width indent
1888 Another name for the
1894 .It Cm stationname Ar name
1895 Set the name of this station.
1896 The station name is not part of the IEEE 802.11
1897 protocol though some interfaces support it.
1899 seems to be meaningful to identical or virtually identical equipment.
1900 Setting the station name is identical in syntax to setting the SSID.
1907 Another way of saying
1913 Another way of saying
1919 Another way of saying:
1920 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1926 .Ar n : k1 , k2 , k3 , k4
1929 Another way of saying
1930 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1935 Another way of saying
1942 The following parameters are specific to bridge interfaces:
1943 .Bl -tag -width indent
1944 .It Cm addm Ar interface
1945 Add the interface named by
1947 as a member of the bridge.
1948 The interface is put into promiscuous mode
1949 so that it can receive every packet sent on the network.
1950 .It Cm deletem Ar interface
1951 Remove the interface named by
1954 Promiscuous mode is disabled on the interface when
1955 it is removed from the bridge.
1956 .It Cm maxaddr Ar size
1957 Set the size of the bridge address cache to
1959 The default is 100 entries.
1960 .It Cm timeout Ar seconds
1961 Set the timeout of address cache entries to
1966 is zero, then address cache entries will not be expired.
1967 The default is 1200 seconds.
1969 Display the addresses that have been learned by the bridge.
1970 .It Cm static Ar interface-name Ar address
1971 Add a static entry into the address cache pointing to
1972 .Ar interface-name .
1973 Static entries are never aged out of the cache or re-placed, even if the
1974 address is seen on a different interface.
1975 .It Cm deladdr Ar address
1978 from the address cache.
1980 Delete all dynamically-learned addresses from the address cache.
1982 Delete all addresses, including static addresses, from the address cache.
1983 .It Cm discover Ar interface
1984 Mark an interface as a
1987 When the bridge has no address cache entry
1988 (either dynamic or static)
1989 for the destination address of a packet,
1990 the bridge will forward the packet to all
1991 member interfaces marked as
1993 This is the default for all interfaces added to a bridge.
1994 .It Fl discover Ar interface
1997 attribute on a member interface.
1998 For packets without the
2000 attribute, the only packets forwarded on the interface are broadcast
2001 or multicast packets and packets for which the destination address
2002 is known to be on the interface's segment.
2003 .It Cm learn Ar interface
2004 Mark an interface as a
2007 When a packet arrives on such an interface, the source
2008 address of the packet is entered into the address cache as being a
2009 destination address on the interface's segment.
2010 This is the default for all interfaces added to a bridge.
2011 .It Fl learn Ar interface
2014 attribute on a member interface.
2015 .It Cm span Ar interface
2016 Add the interface named by
2018 as a span port on the bridge.
2019 Span ports transmit a copy of every frame received by the bridge.
2020 This is most useful for snooping a bridged network passively on
2021 another host connected to one of the span ports of the bridge.
2022 .It Fl span Ar interface
2023 Delete the interface named by
2025 from the list of span ports of the bridge.
2026 .It Cm stp Ar interface
2027 Enable Spanning Tree protocol on
2031 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2032 Spanning Tree is used to detect and remove loops in a network topology.
2033 .It Fl stp Ar interface
2034 Disable Spanning Tree protocol on
2036 This is the default for all interfaces added to a bridge.
2037 .It Cm maxage Ar seconds
2038 Set the time that a Spanning Tree protocol configuration is valid.
2039 The default is 20 seconds.
2040 The minimum is 1 second and the maximum is 255 seconds.
2041 .It Cm fwddelay Ar seconds
2042 Set the time that must pass before an interface begins forwarding
2043 packets when Spanning Tree is enabled.
2044 The default is 15 seconds.
2045 The minimum is 1 second and the maximum is 255 seconds.
2046 .It Cm hellotime Ar seconds
2047 Set the time between broadcasting of Spanning Tree protocol
2048 configuration messages.
2049 The default is 2 seconds.
2050 The minimum is 1 second and the maximum is 255 seconds.
2051 .It Cm priority Ar value
2052 Set the bridge priority for Spanning Tree.
2053 The default is 32768.
2054 The minimum is 0 and the maximum is 65536.
2055 .It Cm ifpriority Ar interface Ar value
2056 Set the Spanning Tree priority of
2061 The minimum is 0 and the maximum is 255.
2063 The priority is used to select which interface out of all
2064 forwarding and bonded interfaces with the same MAC
2065 to output a packet on whe
2067 mode is not being used.
2068 Note that interfaces in the 'blocking' state do not participate
2069 in the priority selection.
2070 If the priorities are the same on a non-bonded member, the
2071 designated member will be used.
2072 .It Cm ifpathcost Ar interface Ar value
2073 Set the Spanning Tree path cost of
2078 The minimum is 0 and the maximum is 65535.
2080 The path cost is added to both incoming and outgoing packets on the
2081 member, lower values will make the member more valuable.
2082 .It Cm ifbondweight Ar interface Ar value
2083 Set the number of packets to output on a bonded member before
2084 round-robining to the next member.
2086 Larger values or different values for each member can be used
2087 if bursting would be beneficial or if the outgoing bandwidth
2088 on each of the members is asymmetric.
2089 For example, one specify a value of 6 on tap0 and 4 on tap1
2091 Remember that this also controls packet bursting.
2093 The link0 option enables transparent bridging mode.
2094 The bridge will make every effort to retain the ethernet header
2095 when forwarding packets between interfaces, making the bridging
2096 function work more like a hardware bridge device.
2098 The link1 option enables keepalive transmission and automatically
2099 places a member into a special blocked mode if no keepalive reception
2101 If either sides of the link uses this option then both sides must use
2103 This option is impemented by sending CFG updates on the hello interval
2105 The link is considered lost after 10 intervals (typically 20 seconds).
2107 The link2 option enables channel bonding (see also ifbondweight).
2108 All member interfaces with the same mac address are considered to
2109 be in a bonding group.
2112 is used, you can manually control or copy the mac to create bonding groups.
2113 When interface bonding is enabled normally blocked interfaces belonging
2114 to the same bonding group as an active forwarding interface will be
2115 changed to the bonding state.
2116 Both sides of link the member represents must operate in bonding mode
2117 for this to work, otherwise the remote end may decide to throw away
2121 The following parameters are specific to IP tunnel interfaces,
2123 .Bl -tag -width indent
2124 .It Cm tunnel Ar src_addr dest_addr
2125 Configure the physical source and destination address for IP tunnel
2131 are interpreted as the outer source/destination for the encapsulating
2134 Unconfigure the physical source and destination address for IP tunnel
2135 interfaces previously configured with
2138 Another name for the
2143 The following parameters are specific to
2146 .Bl -tag -width indent
2147 .It Cm vlan Ar vlan_tag
2148 Set the VLAN tag value to
2150 This value is a 16-bit number which is used to create an 802.1Q
2151 VLAN header for packets sent from the
2158 must both be set at the same time.
2159 .It Cm vlandev Ar iface
2160 Associate the physical interface
2165 Packets transmitted through the
2168 diverted to the specified physical interface
2170 with 802.1Q VLAN encapsulation.
2171 Packets with 802.1Q encapsulation received
2172 by the parent interface with the correct VLAN tag will be diverted to
2178 interface is assigned a
2179 copy of the parent interface's flags and the parent's ethernet address.
2184 must both be set at the same time.
2187 interface already has
2188 a physical interface associated with it, this command will fail.
2190 change the association to another physical interface, the existing
2191 association must be cleared first.
2193 Note: if the hardware tagging capability
2194 is set on the parent interface, the
2197 interface's behavior changes:
2200 interface recognizes that the
2201 parent interface supports insertion and extraction of VLAN tags on its
2202 own (usually in firmware) and that it should pass packets to and from
2203 the parent unaltered.
2204 .It Fl vlandev Op Ar iface
2207 pseudo device, disassociate the parent interface from it.
2208 This breaks the link between the
2210 interface and its parent,
2211 clears its VLAN tag, flags and its link address and shuts the interface down.
2214 argument is useless and hence deprecated.
2217 The following parameters are specific to
2220 .Bl -tag -width indent
2221 .It Cm advbase Ar seconds
2222 Specifies the base of the advertisement interval in seconds.
2223 The acceptable values are 1 to 255.
2224 The default value is 1.
2225 .\" The default value is
2226 .\" .Dv CARP_DFLTINTV .
2227 .It Cm advskew Ar interval
2228 Specifies the skew to add to the base advertisement interval to
2229 make one host advertise slower than another host.
2230 It is specified in 1/256 of seconds.
2231 The acceptable values are 1 to 254.
2232 The default value is 0.
2233 .It Cm pass Ar phrase
2234 Set the authentication key to
2237 Set the virtual host ID.
2238 This is a required setting.
2239 Acceptable values are 1 to 255.
2244 utility displays the current configuration for a network interface
2245 when no optional parameters are supplied.
2246 If a protocol family is specified,
2248 will report only the details specific to that protocol family.
2252 flag is passed before an interface name,
2254 will display the capability list and all
2255 of the supported media for the specified interface.
2258 flag is supplied, address lifetime is displayed for IPv6 addresses,
2259 as time offset string.
2263 flag may be used instead of an interface name.
2266 to display information about all interfaces in the system.
2269 flag limits this to interfaces that are down, and
2271 limits this to interfaces that are up.
2272 When no arguments are given,
2278 flag may be used to list all available interfaces on the system, with
2279 no other additional information.
2280 Use of this flag is mutually exclusive
2281 with all other flags and commands, except for
2283 (only list interfaces that are down)
2286 (only list interfaces that are up).
2290 flag may be used to get more verbose status for an interface.
2294 flag may be used to list all of the interface cloners available on
2295 the system, with no additional information.
2296 Use of this flag is mutually exclusive with all other flags and commands.
2300 flag causes keying information for the interface, if available, to be
2302 For example, the values of 802.11 WEP keys will be printed, if accessible to
2304 This information is not printed by default, as it may be considered
2307 Only the super-user may modify the configuration of a network interface.
2309 Messages indicating the specified interface does not exist, the
2310 requested address is unknown, or the user is not privileged and
2311 tried to alter an interface's configuration.
2329 Basic IPv6 node operation requires a link-local address on each
2330 interface configured for IPv6.
2331 Normally, such an address is automatically configured by the
2332 kernel on each interface added to the system; this behaviour may
2333 be disabled by setting the sysctl MIB variable
2334 .Va net.inet6.ip6.auto_linklocal
2337 If you delete such an address using
2339 the kernel may act very odd.
2340 Do this at your own risk.
projects / dragonfly.git / blob