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,
423 feature and disable interrupts on the interface, if driver supports
428 feature and enable interrupt mode on the interface.
430 Create the specified network pseudo-device.
431 If the interface is given without a unit number, try to create a new
432 device with an arbitrary unit number.
433 If creation of an arbitrary device is successful, the new device name is
434 printed to standard output unless the interface is renamed or destroyed
439 Destroy the specified network pseudo-device.
455 Set the routing metric of the interface to
458 The routing metric is used by the routing protocol
460 Higher metrics have the effect of making a route
461 less favorable; metrics are counted as additional hops
462 to the destination network or host.
464 Set the maximum transmission unit of the interface to
466 default is interface specific.
467 The MTU is used to limit the size of packets that are transmitted on an
469 Not all interfaces support setting the MTU, and some interfaces have
471 .It Cm netmask Ar mask
474 Specify how much of the address to reserve for subdividing
475 networks into sub-networks.
476 The mask includes the network part of the local address
477 and the subnet part, which is taken from the host field of the address.
478 The mask can be specified as a single hexadecimal number
481 with a dot-notation Internet address,
482 or with a pseudo-network name listed in the network table
484 The mask contains 1's for the bit positions in the 32-bit address
485 which are to be used for the network and subnet parts,
486 and 0's for the host part.
487 The mask should contain at least the standard network portion,
488 and the subnet field should be contiguous with the network
491 The netmask can also be specified in CIDR notation after the address.
494 option above for more information.
495 .It Cm prefixlen Ar len
499 bits are reserved for subdividing networks into sub-networks.
502 must be integer, and for syntactical reason it must be between 0 to 128.
503 It is almost always 64 under the current IPv6 assignment rule.
504 If the parameter is omitted, 64 is used.
506 The prefix can also be specified using the slash notation after the address.
509 option above for more information.
512 .\" .It Cm nsellength Ar n
515 .\" This specifies a trailing number of bytes for a received
517 .\" used for local identification, the remaining leading part of which is
520 .\" (Network Entity Title).
521 .\" The default value is 1, which is conformant to US
523 .\" When an ISO address is set in an ifconfig command,
526 .\" which is being specified.
529 .\" 20 hex digits should be
532 .\" to be assigned to the interface.
533 .\" There is some evidence that a number different from 1 may be useful
536 .\" 37 type addresses.
537 .It Cm range Ar netrange
538 Under appletalk, set the interface to respond to a
541 .Ar startnet Ns - Ns Ar endnet .
542 Appletalk uses this scheme instead of
545 implements it internally as a set of netmasks.
550 Introduced for compatibility
554 The argument following this specifies the version (phase) of the
555 Appletalk network attached to the interface.
556 Values of 1 or 2 are permitted.
558 .It Cm link Op Cm 0 No - Cm 2
560 Enable special processing of the link level of the interface.
561 These three options are interface specific in actual effect, however,
562 they are in general used to select special modes of operation.
564 of this is to enable SLIP compression, or to select the connector type
565 for some Ethernet cards.
566 Refer to the man page for the specific driver
567 for more information.
569 .It Fl link Op Cm 0 No - Cm 2
571 Disable special processing at the link level with the specified interface.
573 Put the interface in monitor mode.
574 No packets are transmitted, and received packets are discarded after
578 Take the interface out of monitor mode.
582 This may be used to enable an interface after an
584 It happens automatically when setting the first address on an interface.
585 If the interface was reset when previously marked down,
586 the hardware will be re-initialized.
589 The following parameters are specific to cloning
590 IEEE 802.11 wireless interfaces with the
593 .Bl -tag -width indent
594 .It Cm wlandev Ar device
597 as the parent for the cloned device.
598 .It Cm wlanmode Ar mode
599 Specify the operating mode for this cloned device.
616 The operating mode of a cloned interface cannot be changed.
619 mode is actually implemented as an
621 interface with special properties.
622 .It Cm wlanbssid Ar bssid
623 The 802.11 mac address to use for the bssid.
624 This must be specified at create time for a legacy
627 .It Cm wlanaddr Ar address
628 The local mac address.
629 If this is not specified then a mac address will automatically be assigned
630 to the cloned device.
631 Typically this address is the same as the address of the parent device
634 parameter is specified then the driver will craft a unique address for
635 the device (if supported).
639 device as operating in ``legacy mode''.
642 devices have a fixed peer relationship and do not, for example, roam
643 if their peer stops communicating.
644 For completeness a Dynamic WDS (DWDS) interface may marked as
647 Request a unique local mac address for the cloned device.
648 This is only possible if the device supports multiple mac addresses.
649 To force use of the parent's mac address use
652 Mark the cloned interface as depending on hardware support to
653 track received beacons.
654 To have beacons tracked in software use
660 can also be used to indicate no beacons should
661 be transmitted; this can be useful when creating a WDS configuration but
663 interfaces can only be created as companions to an access point.
666 The following parameters are specific to IEEE 802.11 wireless interfaces
670 .Bl -tag -width indent
672 Enable sending and receiving AMPDU frames when using 802.11n (default).
673 The 802.11n specification states a compliant station must be capable
674 of receiving AMPDU frames but transmision is optional.
677 to disable all use of AMPDU with 802.11n.
678 For testing and/or to work around interoperability problems one can use
682 to control use of AMPDU in one direction.
683 .It Cm ampdudensity Ar density
684 Set the AMPDU density parameter used when operating with 802.11n.
685 This parameter controls the inter-packet gap for AMPDU frames.
686 The sending device normally controls this setting but a receiving station
687 may request wider gaps.
690 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
693 is treated the same as 0.
694 .It Cm ampdulimit Ar limit
695 Set the limit on packet size for receiving AMPDU frames when operating
699 are 8192, 16384, 32768, and 65536 but one can also specify
700 just the unique prefix: 8, 16, 32, 64.
701 Note the sender may limit the size of AMPDU frames to be less
702 than the maximum specified by the receiving station.
704 Enable sending and receiving AMSDU frames when using 802.11n.
705 By default AMSDU is received but not transmitted.
708 to disable all use of AMSDU with 802.11n.
709 For testing and/or to work around interoperability problems one can use
713 to control use of AMSDU in one direction.
714 .It Cm amsdulimit Ar limit
715 Set the limit on packet size for sending and receiving AMSDU frames
716 when operating with 802.11n.
719 are 7935 and 3839 (bytes).
720 Note the sender may limit the size of AMSDU frames to be less
721 than the maximum specified by the receiving station.
722 Note also that devices are not required to support the 7935 limit,
723 only 3839 is required by the specification and the larger value
724 may require more memory to be dedicated to support functionality
727 When operating as an access point, pass packets between
728 wireless clients directly (default).
729 To instead let them pass up through the
730 system and be forwarded using some other mechanism, use
732 Disabling the internal bridging
733 is useful when traffic is to be processed with
735 .It Cm authmode Ar mode
736 Set the desired authentication mode in infrastructure mode.
737 Not all adapters support all modes.
740 .Cm none , open , shared
746 (IEEE WPA/WPA2/802.11i).
751 modes are only useful when using an authentication service
752 (a supplicant for client operation or an authenticator when
753 operating as an access point).
754 Modes are case insensitive.
756 Enable background scanning when operating as a station.
757 Background scanning is a technique whereby a station associated to
758 an access point will temporarily leave the channel to scan for
759 neighboring stations.
760 This allows a station to maintain a cache of nearby access points
761 so that roaming between access points can be done without
762 a lengthy scan operation.
763 Background scanning is done only when a station is not busy and
764 any outbound traffic will cancel a scan operation.
765 Background scanning should never cause packets to be lost though
766 there may be some small latency if outbound traffic interrupts a
768 By default background scanning is enabled if the device is capable.
769 To disable background scanning, use
771 Background scanning is controlled by the
776 Background scanning must be enabled for roaming; this is an artifact
777 of the current implementation and may not be required in the future.
778 .It Cm bgscanidle Ar idletime
779 Set the minimum time a station must be idle (not transmitting or
780 receiving frames) before a background scan is initiated.
783 parameter is specified in milliseconds.
784 By default a station must be idle at least 250 milliseconds before
785 a background scan is initiated.
786 The idle time may not be set to less than 100 milliseconds.
787 .It Cm bgscanintvl Ar interval
788 Set the interval at which background scanning is attempted.
791 parameter is specified in seconds.
792 By default a background scan is considered every 300 seconds (5 minutes).
795 may not be set to less than 15 seconds.
796 .It Cm bintval Ar interval
797 Set the interval at which beacon frames are sent when operating in
801 parameter is specified in TU's (1024 usecs).
802 By default beacon frames are transmitted every 100 TU's.
803 .It Cm bmissthreshold Ar count
804 Set the number of consecutive missed beacons at which the station
805 will attempt to roam (i.e., search for a new access point).
808 parameter must be in the range 1 to 255; though the
809 upper bound may be reduced according to device capabilities.
810 The default threshold is 7 consecutive missed beacons; but
811 this may be overridden by the device driver.
816 .It Cm bssid Ar address
817 Specify the MAC address of the access point to use when operating
818 as a station in a BSS network.
819 This overrides any automatic selection done by the system.
820 To disable a previously selected access point, supply
825 This option is useful when more than one access point uses the same SSID.
831 Enable packet bursting.
832 Packet bursting is a transmission technique whereby the wireless
833 medium is acquired once to send multiple frames and the interframe
835 This technique can significantly increase throughput by reducing
836 transmission overhead.
837 Packet bursting is supported by the 802.11e QoS specification
838 and some devices that do not support QoS may still be capable.
839 By default packet bursting is enabled if a device is capable
841 To disable packet bursting, use
843 .It Cm chanlist Ar channels
844 Set the desired channels to use when scanning for access
845 points, neighbors in an IBSS network, or looking for unoccupied
846 channels when operating as an access point.
847 The set of channels is specified as a comma-separated list with
848 each element in the list representing either a single channel number or a range
851 Channel numbers must be in the range 1 to 255 and be permissible
852 according to the operating characteristics of the device.
853 .It Cm channel Ar number
854 Set a single desired channel.
855 Channels range from 1 to 255, but the exact selection available
856 depends on the region your adaptor was manufactured for.
862 will clear any desired channel and, if the device is marked up,
863 force a scan for a channel to operate on.
864 Alternatively the frequency, in megahertz, may be specified
865 instead of the channel number.
867 When there are several ways to use a channel the channel
868 number/frequency may be appended with attributes to clarify.
869 For example, if a device is capable of operating on channel 6
870 with 802.11n and 802.11g then one can specify that g-only use
871 should be used by specifying ``6:g''.
872 Similarly the channel width can be specified by appending it
873 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
874 These attributes can be combined as in: ``6:ht/40''.
875 The full set of flags specified following a `:'' are:
881 (Atheros Dynamic Turbo mode),
889 (Atheros Static Turbo mode),
892 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
893 The full set of channel widths following a '/' are:
895 (5MHz aka quarter-rate channel),
897 (10MHz aka half-rate channel),
899 (20MHz mostly for use in specifying ht20),
902 (40MHz mostly for use in specifying ht40),
904 a 40MHz HT channel specification may include the location
905 of the extension channel by appending ``+'' or ``-'' for above and below,
906 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
907 with the center channel at frequency 2437 and the extension channel above.
908 .It Cm country Ar name
909 Set the country code to use in calculating the regulatory constraints
911 In particular the set of available channels, how the wireless device
912 will operation on the channels, and the maximum transmit power that
913 can be used on a channel are defined by this setting.
914 Country/Region codes are specified as a 2-character abbreviation
915 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
916 e.g. "ES" and "Spain".
917 The set of country codes are taken from /etc/regdomain.xml and can also
918 be viewed with the ``list countries'' request.
919 Note that not all devices support changing the country code from a default
920 setting; typically stored in EEPROM.
928 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
929 DFS embodies several facilities including detection of overlapping
930 radar signals, dynamic transmit power control, and channel selection
931 according to a least-congested criteria.
932 DFS support is mandatory for some 5Ghz frequencies in certain
934 By default DFS is enabled according to the regulatory definitions
935 specified in /etc/regdomain.xml and the curent country code, regdomain,
937 Note the underlying device (and driver) must support radar detection
938 for full DFS support to work.
939 To be fully compliant with the local regulatory agency frequencies that
940 require DFS should not be used unless it is fully supported.
943 to disable this functionality for testing.
945 Enable support for the 802.11d specification (default).
946 When this support is enabled in station mode, beacon frames that advertise
947 a country code different than the currently configured country code will
948 cause an event to be dispatched to user applications.
949 This event can be used by the station to adopt that country code and
950 operate according to the associated regulatory constraints.
951 When operating as an access point with 802.11d enabled the beacon and
952 probe response frames transmitted will advertise the current regulatory
954 To disable 802.11d use
957 Enable 802.11h support including spectrum management.
958 When 802.11h is enabled beacon and probe response frames will have
959 the SpectrumMgt bit set in the capabilities field and
960 country and power constraint information elements will be present.
961 802.11h support also includes handling Channel Switch Announcements (CSA)
962 which are a mechanism to coordinate channel changes by an access point.
963 By default 802.11h is enabled if the device is capable.
964 To disable 802.11h use
966 .It Cm deftxkey Ar index
967 Set the default key to use for transmission.
968 Typically this is only set when using WEP encryption.
969 Note that you must set a default transmit key
970 for the system to know which key to use in encrypting outbound traffic.
973 is an alias for this request; it is provided for backwards compatibility.
974 .It Cm dtimperiod Ar period
977 period for transmitting buffered multicast data frames when
978 operating in ap mode.
981 specifies the number of beacon intervals between DTIM
982 and must be in the range 1 to 15.
983 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
985 Enable the use of Atheros Dynamic Turbo mode when communicating with
986 another Dynamic Turbo-capable station.
987 Dynamic Turbo mode is an Atheros-specific mechanism by which
988 stations switch between normal 802.11 operation and a ``boosted''
989 mode in which a 40MHz wide channel is used for communication.
990 Stations using Dynamic Turbo mode operate boosted only when the
991 channel is free of non-dturbo stations; when a non-dturbo station
992 is identified on the channel all stations will automatically drop
993 back to normal operation.
994 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
995 Note that turbo mode (dynamic or static) is only allowed on some
996 channels depending on the regulatory constraints; use the
998 command to identify the channels where turbo mode may be used.
999 To disable Dynamic Turbo mode use
1002 Enable Dynamic WDS (DWDS) support.
1003 DWDS is a facility by which 4-address traffic can be carried between
1004 stations operating in infrastructure mode.
1005 A station first associates to an access point and authenticates using
1006 normal procedures (e.g. WPA).
1007 Then 4-address frames are passed to carry traffic for stations
1008 operating on either side of the wireless link.
1009 DWDS extends the normal WDS mechanism by leveraging existing security
1010 protocols and eliminating static binding.
1012 When DWDS is enabled on an access point 4-address frames received from
1013 an authorized station will generate a ``DWDS discovery'' event to user
1015 This event should be used to create a WDS interface that is bound
1016 to the remote station (and usually plumbed into a bridge).
1017 Once the WDS interface is up and running 4-address traffic then logically
1018 flows through that interface.
1020 When DWDS is enabled on a station, traffic with a destination address
1021 different from the peer station are encapsulated in a 4-address frame
1022 and transmitted to the peer.
1023 All 4-address traffic uses the security information of the stations
1024 (e.g. cryptographic keys).
1025 A station is associated using 802.11n facilities may transport
1026 4-address traffic using these same mechanisms; this depends on available
1027 resources and capabilities of the device.
1028 The DWDS implementation guards against layer 2 routing loops of
1031 Enable the use of Atheros Fast Frames when communicating with
1032 another Fast Frames-capable station.
1033 Fast Frames are an encapsulation technique by which two 802.3
1034 frames are transmitted in a single 802.11 frame.
1035 This can noticeably improve throughput but requires that the
1036 receiving station understand how to decapsulate the frame.
1037 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1038 protocol extension so enabling use is safe when communicating with
1039 non-Atheros devices.
1040 By default, use of fast frames is enabled if the device is capable.
1041 To explicitly disable fast frames, use
1043 .It Cm fragthreshold Ar length
1044 Set the threshold for which transmitted frames are broken into fragments.
1047 argument is the frame size in bytes and must be in the range 256 to 2346.
1055 disables transmit fragmentation.
1056 Not all adapters honor the fragmentation threshold.
1058 When operating as an access point, do not broadcast the SSID
1059 in beacon frames or respond to probe request frames unless
1060 they are directed to the ap (i.e., they include the ap's SSID).
1061 By default, the SSID is included in beacon frames and
1062 undirected probe request frames are answered.
1063 To re-enable the broadcast of the SSID etc., use
1066 Enable use of High Throughput (HT) when using 802.11n (default).
1067 The 802.11n specification includes mechanisms for operation
1068 on 20MHz and 40MHz wide channels using different signalling mechanisms
1069 than specified in 802.11b, 802.11g, and 802.11a.
1070 Stations negotiate use of these facilities, termed HT20 and HT40,
1071 when they associate.
1072 To disable all use of 802.11n use
1074 To disable use of HT20 (e.g. to force only HT40 use) use
1076 To disable use of HT40 use
1079 HT configuration is used to ``auto promote'' operation
1080 when several choices are available.
1081 For example, if a station associates to an 11n-capable access point
1082 it controls whether the station uses legacy operation, HT20, or HT40.
1083 When an 11n-capable device is setup as an access point and
1084 Auto Channel Selection is used to locate a channel to operate on,
1085 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1086 on the selected channel.
1087 If a fixed channel is specified for a station then HT configuration can
1088 be given as part of the channel specification; e.g. 6:ht/20 to setup
1089 HT20 operation on channel 6.
1091 Enable use of compatibility support for pre-802.11n devices (default).
1092 The 802.11n protocol specification went through several incompatible iterations.
1093 Some vendors implemented 11n support to older specifications that
1094 will not interoperate with a purely 11n-compliant station.
1095 In particular the information elements included in management frames
1096 for old devices are different.
1097 When compatibility support is enabled both standard and compatible data
1099 Stations that associate using the compatiblity mechanisms are flagged
1101 To disable compatiblity support use
1103 .It Cm htprotmode Ar technique
1104 For interfaces operating in 802.11n, use the specified
1106 for protecting HT frames in a mixed legacy/HT network.
1107 The set of valid techniques is
1112 Technique names are case insensitive.
1114 Enable inactivity processing for stations associated to an
1115 access point (default).
1116 When operating as an access point the 802.11 layer monitors
1117 the activity of each associated station.
1118 When a station is inactive for 5 minutes it will send several
1119 ``probe frames'' to see if the station is still present.
1120 If no response is received then the station is deauthenticated.
1121 Applications that prefer to handle this work can disable this
1125 Set the location to use in calculating regulatory constraints.
1126 The location is also advertised in beacon and probe response frames
1127 when 802.11d is enabled with
1136 Display the list of channels available for use taking into account
1137 any restrictions set with the
1140 See the description of
1142 for more information.
1144 Display the adaptor's capabilities, including the operating
1147 Display the list of channels available for use.
1148 Channels are shown with their IEEE channel number, equivalent
1149 frequency, and usage modes.
1150 Channels identified as
1155 Channels identified as
1157 may be used only for Atheros' Static Turbo mode
1159 . Cm mediaopt turbo ) .
1160 Channels marked with a
1162 have a regulatory constraint that they be passively scanned.
1163 This means a station is not permitted to transmit on the channel until
1164 it identifies the channel is being used for 802.11 communication;
1165 typically by hearing a beacon frame from an access point operating
1168 is another way of requesting this information.
1169 By default a compacted list of channels is displayed; if the
1171 option is specified then all channels are shown.
1172 .It Cm list countries
1173 Display the set of country codes and regulatory domains that can be
1174 used in regulatory configuration.
1176 Display the current MAC Access Control List state.
1177 Each address is prefixed with a character that indicates the
1178 current policy applied to it:
1180 indicates the address is allowed access,
1182 indicates the address is denied access,
1184 indicates the address is present but the current policy open
1185 (so the ACL is not consulted).
1186 .It Cm list regdomain
1187 Display the current regulatory settings including the available channels
1188 and transmit power caps.
1190 Display the parameters that govern roaming operation.
1192 Display the parameters that govern transmit operation.
1194 Display the transmit power caps for each channel.
1196 Display the access points and/or ad-hoc neighbors
1197 located in the vicinity.
1198 This information may be updated automatically by the adapter
1201 request or through background scanning.
1202 Depending on the capabilities of the stations the following
1203 flags can be included in the output:
1207 Indicates that the station is permitted to send/receive data frames.
1209 Extended Rate Phy (ERP).
1210 Indicates that the station is operating in an 802.11g network
1211 using extended transmit rates.
1213 High Throughput (HT).
1214 Indicates that the station is using HT transmit rates.
1215 If a `+' follows immediately after then the station associated
1216 using deprecated mechanisms supported only when
1221 Indicates that the station is operating in power save mode.
1223 Quality of Service (QoS).
1224 Indicates that the station is using QoS encapsulation for
1226 QoS encapsulation is enabled only when WME mode is enabled.
1228 Transitional Security Network (TSN).
1229 Indicates that the station associated using TSN; see also
1233 Wi-Fi Protected Setup (WPS).
1234 Indicates that the station associated using WPS.
1237 By default interesting information elements captured from the neighboring
1238 stations are displayed at the end of each row.
1239 Possible elements include:
1241 (station supports WME),
1243 (station supports WPA),
1245 (station supports WPS),
1247 (station supports 802.11i/RSN),
1249 (station supports 802.11n/HT communication),
1251 (station supports Atheros protocol extensions),
1253 (station supports unknown vendor-specific extensions).
1256 flag is used all the information elements and their
1257 contents will be shown.
1260 flag also enables display of long SSIDs.
1263 command is another way of requesting this information.
1265 When operating as an access point display the stations that are
1266 currently associated.
1267 When operating in ad-hoc mode display stations identified as
1268 neighbors in the IBSS.
1269 When operating in station mode display the access point.
1270 Capabilities advertised by the stations are described under
1274 Depending on the capabilities of the stations the following
1275 flags can be included in the output:
1279 Indicates that the station is permitted to send/receive data frames.
1281 Extended Rate Phy (ERP).
1282 Indicates that the station is operating in an 802.11g network
1283 using extended transmit rates.
1285 High Throughput (HT).
1286 Indicates that the station is using HT transmit rates.
1287 If a `+' follows immediately after then the station associated
1288 using deprecated mechanisms supported only when
1293 Indicates that the station is operating in power save mode.
1295 Quality of Service (QoS).
1296 Indicates that the station is using QoS encapsulation for
1298 QoS encapsulation is enabled only when WME mode is enabled.
1300 Transitional Security Network (TSN).
1301 Indicates that the station associated using TSN; see also
1305 Wi-Fi Protected Setup (WPS).
1306 Indicates that the station associated using WPS.
1309 By default information elements received from associated stations
1310 are displayed in a short form; the
1312 flag causes this information to be displayed symbolically.
1314 Display the current channel parameters to use when operating in WME mode.
1317 option is specified then both channel and BSS parameters are displayed
1318 for each AC (first channel, then BSS).
1319 When WME mode is enabled for an adaptor this information will be
1320 displayed with the regular status; this command is mostly useful
1321 for examining parameters when WME mode is disabled.
1322 See the description of the
1324 directive for information on the various parameters.
1325 .It Cm maxretry Ar count
1326 Set the maximum number of tries to use in sending unicast frames.
1327 The default setting is 6 but drivers may override this with a value
1329 .It Cm mcastrate Ar rate
1330 Set the rate for transmitting multicast/broadcast frames.
1331 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1332 This rate should be valid for the current operating conditions;
1333 if an invalid rate is specified drivers are free to chose an
1335 .It Cm mgtrate Ar rate
1336 Set the rate for transmitting management and/or control frames.
1337 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1339 Set the location to use in calculating regulatory constraints.
1340 The location is also advertised in beacon and probe response frames
1341 when 802.11d is enabled with
1350 Enable powersave operation.
1351 When operating as a client, the station will conserve power by
1352 periodically turning off the radio and listening for
1353 messages from the access point telling it there are packets waiting.
1354 The station must then retrieve the packets.
1355 Not all devices support power save operation as a client.
1356 The 802.11 specification requires that all access points support
1357 power save but some drivers do not.
1360 to disable powersave operation when operating as a client.
1361 .It Cm powersavesleep Ar sleep
1362 Set the desired max powersave sleep time in TU's (1024 usecs).
1363 By default the max powersave sleep time is 100 TU's.
1364 .It Cm protmode Ar technique
1365 For interfaces operating in 802.11g, use the specified
1367 for protecting OFDM frames in a mixed 11b/11g network.
1368 The set of valid techniques is
1374 Technique names are case insensitive.
1375 Not all devices support
1377 as a protection technique.
1379 When operating as an access point in 802.11g mode allow only
1380 11g-capable stations to associate (11b-only stations are not
1381 permitted to associate).
1382 To allow both 11g and 11b-only stations to associate, use
1385 When operating as an access point in 802.11n mode allow only
1386 HT-capable stations to associate (legacy stations are not
1387 permitted to associate).
1388 To allow both HT and legacy stations to associate, use
1390 .It Cm regdomain Ar sku
1391 Set the regulatory domain to use in calculating the regulatory constraints
1393 In particular the set of available channels, how the wireless device
1394 will operation on the channels, and the maximum transmit power that
1395 can be used on a channel are defined by this setting.
1396 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1397 be viewed with the ``list countries'' request.
1398 Note that not all devices support changing the regdomain from a default
1399 setting; typically stored in EEPROM.
1407 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1409 Note that RIFS must be supported by both the station and access point
1413 .It Cm roam:rate Ar rate
1414 Set the threshold for controlling roaming when operating in a BSS.
1417 parameter specifies the transmit rate in megabits
1418 at which roaming should be considered.
1419 If the current transmit rate drops below this setting and background scanning
1420 is enabled, then the system will check if a more desirable access point is
1421 available and switch over to it.
1422 The current scan cache contents are used if they are considered
1423 valid according to the
1425 parameter; otherwise a background scan operation is triggered before
1426 any selection occurs.
1427 Each channel type has a separate rate threshold; the default values are:
1428 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1429 .It Cm roam:rssi Ar rssi
1430 Set the threshold for controlling roaming when operating in a BSS.
1433 parameter specifies the receive signal strength in dBm units
1434 at which roaming should be considered.
1435 If the current rssi drops below this setting and background scanning
1436 is enabled, then the system will check if a more desirable access point is
1437 available and switch over to it.
1438 The current scan cache contents are used if they are considered
1439 valid according to the
1441 parameter; otherwise a background scan operation is triggered before
1442 any selection occurs.
1443 Each channel type has a separate rssi threshold; the default values are
1445 .It Cm roaming Ar mode
1446 When operating as a station, control how the system will
1447 behave when communication with the current access point
1451 argument may be one of
1453 (leave it to the hardware device to decide),
1455 (handle either in the device or the operating system\[em]as appropriate),
1457 (do nothing until explicitly instructed).
1458 By default, the device is left to handle this if it is
1459 capable; otherwise, the operating system will automatically
1460 attempt to reestablish communication.
1461 Manual mode is used by applications such as
1462 .Xr wpa_supplicant 8
1463 that want to control the selection of an access point.
1464 .It Cm rtsthreshold Ar length
1465 Set the threshold for which
1466 transmitted frames are preceded by transmission of an
1472 is the frame size in bytes and must be in the range 1 to 2346.
1480 disables transmission of RTS frames.
1481 Not all adapters support setting the RTS threshold.
1483 Initiate a scan of neighboring stations, wait for it to complete, and
1484 display all stations found.
1485 Only the super-user can initiate a scan.
1488 for information on the display.
1489 By default a background scan is done; otherwise a foreground
1490 scan is done and the station may roam to a different access point.
1493 request can be used to show recent scan results without
1494 initiating a new scan.
1495 .It Cm scanvalid Ar threshold
1496 Set the maximum time the scan cache contents are considered valid;
1497 i.e. will be used without first triggering a scan operation to
1501 parameter is specified in seconds and defaults to 60 seconds.
1502 The minimum setting for
1505 One should take care setting this threshold; if it is set too low
1506 then attempts to roam to another access point may trigger unnecessary
1507 background scan operations.
1509 Enable use of Short Guard Interval when operating in 802.11n
1511 NB: this currently enables Short GI on both HT40 and HT20 channels.
1512 To disable Short GI use
1515 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1516 when operating in 802.11n.
1517 A station operating with Static SMPS maintains only a single
1518 receive chain active (this can significantly reduce power consumption).
1522 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1523 when operating in 802.11n.
1524 A station operating with Dynamic SMPS maintains only a single
1525 receive chain active but switches to multiple receive chains when it
1526 receives an RTS frame (this can significantly reduce power consumption).
1527 Note that stations cannot distinguish between RTS/CTS intended to
1528 enable multiple receive chains and those used for other purposes.
1532 Set the desired Service Set Identifier (aka network name).
1533 The SSID is a string up to 32 characters
1534 in length and may be specified as either a normal string or in
1535 hexadecimal when preceded by
1537 Additionally, the SSID may be cleared by setting it to
1539 .It Cm tdmaslot Ar slot
1540 When operating with TDMA, use the specified
1545 is a number between 0 and the maximum number of slots in the BSS.
1546 Note that a station configured as slot 0 is a master and
1547 will broadcast beacon frames advertising the BSS;
1548 stations configured to use other slots will always
1549 scan to locate a master before they ever transmit.
1553 .It Cm tdmaslotcnt Ar cnt
1554 When operating with TDMA, setup a BSS with
1557 The slot count may be at most 8.
1558 The current implementation is only tested with two stations
1559 (i.e. point to point applications).
1560 This setting is only meaningful when a station is configured as slot 0;
1561 other stations adopt this setting from the BSS they join.
1565 .It Cm tdmaslotlen Ar len
1566 When operating with TDMA, setup a BSS such that each station has a slot
1569 The slot length must be at least 150 microseconds (1/8 TU)
1570 and no more than 65 milliseconds.
1571 Note that setting too small a slot length may result in poor channel
1572 bandwidth utilization due to factors such as timer granularity and
1574 This setting is only meaningful when a station is configured as slot 0;
1575 other stations adopt this setting from the BSS they join.
1578 is set to 10 milliseconds.
1579 .It Cm tdmabintval Ar intval
1580 When operating with TDMA, setup a BSS such that beacons are transmitted every
1582 superframes to synchronize the TDMA slot timing.
1583 A superframe is defined as the number of slots times the slot length; e.g.
1584 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1585 The beacon interval may not be zero.
1588 causes the timers to be resynchronized more often; this can be help if
1589 significant timer drift is observed.
1594 When operating as an access point with WPA/802.11i allow legacy
1595 stations to associate using static key WEP and open authentication.
1596 To disallow legacy station use of WEP, use
1598 .It Cm txpower Ar power
1599 Set the power used to transmit frames.
1602 argument is specified in .5 dBm units.
1603 Out of range values are truncated.
1604 Typically only a few discreet power settings are available and
1605 the driver will use the setting closest to the specified value.
1606 Not all adapters support changing the transmit power.
1607 .It Cm ucastrate Ar rate
1608 Set a fixed rate for transmitting unicast frames.
1609 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1610 This rate should be valid for the current operating conditions;
1611 if an invalid rate is specified drivers are free to chose an
1613 .It Cm wepmode Ar mode
1614 Set the desired WEP mode.
1615 Not all adapters support all modes.
1616 The set of valid modes is
1622 mode explicitly tells the adaptor to allow association with access
1623 points which allow both encrypted and unencrypted traffic.
1626 means that the access point must only allow encrypted connections.
1629 is generally another name for
1631 Modes are case insensitive.
1632 .It Cm weptxkey Ar index
1633 Set the WEP key to be used for transmission.
1634 This is the same as setting the default transmission key with
1636 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1637 Set the selected WEP key.
1640 is not given, key 1 is set.
1641 A WEP key will be either 5 or 13
1642 characters (40 or 104 bits) depending of the local network and the
1643 capabilities of the adaptor.
1644 It may be specified either as a plain
1645 string or as a string of hexadecimal digits preceded by
1647 For maximum portability, hex keys are recommended;
1648 the mapping of text keys to WEP encryption is usually driver-specific.
1651 drivers do this mapping differently to
1653 A key may be cleared by setting it to
1655 If WEP is supported then there are at least four keys.
1656 Some adapters support more than four keys.
1657 If that is the case, then the first four keys
1658 (1-4) will be the standard temporary keys and any others will be adaptor
1659 specific keys such as permanent keys stored in NVRAM.
1661 Note that you must set a default transmit key with
1663 for the system to know which key to use in encrypting outbound traffic.
1665 Enable Wireless Multimedia Extensions (WME) support, if available,
1666 for the specified interface.
1667 WME is a subset of the IEEE 802.11e standard to support the
1668 efficient communication of realtime and multimedia data.
1669 To disable WME support, use
1671 Another name for this parameter is
1674 The following parameters are meaningful only when WME support is in use.
1675 Parameters are specified per-AC (Access Category) and
1676 split into those that are used by a station when acting
1677 as an access point and those for client stations in the BSS.
1678 The latter are received from the access point and may not be changed
1680 The following Access Categories are recognized:
1682 .Bl -tag -width ".Cm AC_BK" -compact
1686 best effort delivery,
1701 AC parameters are case-insensitive.
1702 Traffic classification is done in the operating system using the
1703 vlan priority associated with data frames or the
1704 ToS (Type of Service) indication in IP-encapsulated frames.
1705 If neither information is present, traffic is assigned to the
1706 Best Effort (BE) category.
1707 .Bl -tag -width indent
1709 Set the ACK policy for QoS transmissions by the local station;
1710 this controls whether or not data frames transmitted by a station
1711 require an ACK response from the receiving station.
1712 To disable waiting for an ACK use
1714 This parameter is applied only to the local station.
1716 Enable the Admission Control Mandatory (ACM) mechanism
1717 for transmissions by the local station.
1718 To disable the ACM use
1720 On stations in a BSS this parameter is read-only and indicates
1721 the setting received from the access point.
1722 NB: ACM is not supported right now.
1723 .It Cm aifs Ar ac Ar count
1724 Set the Arbitration Inter Frame Spacing (AIFS)
1725 channel access parameter to use for transmissions
1726 by the local station.
1727 On stations in a BSS this parameter is read-only and indicates
1728 the setting received from the access point.
1729 .It Cm cwmin Ar ac Ar count
1730 Set the CWmin channel access parameter to use for transmissions
1731 by the local station.
1732 On stations in a BSS this parameter is read-only and indicates
1733 the setting received from the access point.
1734 .It Cm cwmax Ar ac Ar count
1735 Set the CWmax channel access parameter to use for transmissions
1736 by the local station.
1737 On stations in a BSS this parameter is read-only and indicates
1738 the setting received from the access point.
1739 .It Cm txoplimit Ar ac Ar limit
1740 Set the Transmission Opportunity Limit channel access parameter
1741 to use for transmissions by the local station.
1742 This parameter defines an interval of time when a WME station
1743 has the right to initiate transmissions onto the wireless medium.
1744 On stations in a BSS this parameter is read-only and indicates
1745 the setting received from the access point.
1746 .It Cm bss:aifs Ar ac Ar count
1747 Set the AIFS channel access parameter to send to stations in a BSS.
1748 This parameter is meaningful only when operating in ap mode.
1749 .It Cm bss:cwmin Ar ac Ar count
1750 Set the CWmin channel access parameter to send to stations in a BSS.
1751 This parameter is meaningful only when operating in ap mode.
1752 .It Cm bss:cwmax Ar ac Ar count
1753 Set the CWmax channel access parameter to send to stations in a BSS.
1754 This parameter is meaningful only when operating in ap mode.
1755 .It Cm bss:txoplimit Ar ac Ar limit
1756 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1757 This parameter is meaningful only when operating in ap mode.
1760 Enable Wireless Privacy Subscriber support.
1761 Note that WPS support requires a WPS-capable supplicant.
1762 To disable this function use
1766 The following parameters support an optional access control list
1767 feature available with some adapters when operating in ap mode; see
1769 This facility allows an access point to accept/deny association
1770 requests based on the MAC address of the station.
1771 Note that this feature does not significantly enhance security
1772 as MAC address spoofing is easy to do.
1773 .Bl -tag -width indent
1774 .It Cm mac:add Ar address
1775 Add the specified MAC address to the database.
1776 Depending on the policy setting association requests from the
1777 specified station will be allowed or denied.
1779 Set the ACL policy to permit association only by
1780 stations registered in the database.
1781 .It Cm mac:del Ar address
1782 Delete the specified MAC address from the database.
1784 Set the ACL policy to deny association only by
1785 stations registered in the database.
1786 .It Cm mac:kick Ar address
1787 Force the specified station to be deauthenticated.
1788 This typically is done to block a station after updating the
1791 Set the ACL policy to allow all stations to associate.
1793 Delete all entries in the database.
1795 Set the ACL policy to permit association only by
1796 stations approved by a RADIUS server.
1797 Note that this feature requires the
1799 program be configured to do the right thing
1800 as it handles the RADIUS processing
1801 (and marks stations as authorized).
1804 The following parameters are for compatibility with other systems:
1805 .Bl -tag -width indent
1807 Another name for the
1813 .It Cm stationname Ar name
1814 Set the name of this station.
1815 The station name is not part of the IEEE 802.11
1816 protocol though some interfaces support it.
1818 seems to be meaningful to identical or virtually identical equipment.
1819 Setting the station name is identical in syntax to setting the SSID.
1826 Another way of saying
1832 Another way of saying
1838 Another way of saying:
1839 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1845 .Ar n : k1 , k2 , k3 , k4
1848 Another way of saying
1849 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1854 Another way of saying
1861 The following parameters are specific to bridge interfaces:
1862 .Bl -tag -width indent
1863 .It Cm addm Ar interface
1864 Add the interface named by
1866 as a member of the bridge.
1867 The interface is put into promiscuous mode
1868 so that it can receive every packet sent on the network.
1869 .It Cm deletem Ar interface
1870 Remove the interface named by
1873 Promiscuous mode is disabled on the interface when
1874 it is removed from the bridge.
1875 .It Cm maxaddr Ar size
1876 Set the size of the bridge address cache to
1878 The default is 100 entries.
1879 .It Cm timeout Ar seconds
1880 Set the timeout of address cache entries to
1885 is zero, then address cache entries will not be expired.
1886 The default is 240 seconds.
1888 Display the addresses that have been learned by the bridge.
1889 .It Cm static Ar interface-name Ar address
1890 Add a static entry into the address cache pointing to
1891 .Ar interface-name .
1892 Static entries are never aged out of the cache or re-placed, even if the
1893 address is seen on a different interface.
1894 .It Cm deladdr Ar address
1897 from the address cache.
1899 Delete all dynamically-learned addresses from the address cache.
1901 Delete all addresses, including static addresses, from the address cache.
1902 .It Cm discover Ar interface
1903 Mark an interface as a
1906 When the bridge has no address cache entry
1907 (either dynamic or static)
1908 for the destination address of a packet,
1909 the bridge will forward the packet to all
1910 member interfaces marked as
1912 This is the default for all interfaces added to a bridge.
1913 .It Cm -discover Ar interface
1916 attribute on a member interface.
1917 For packets without the
1919 attribute, the only packets forwarded on the interface are broadcast
1920 or multicast packets and packets for which the destination address
1921 is known to be on the interface's segment.
1922 .It Cm learn Ar interface
1923 Mark an interface as a
1926 When a packet arrives on such an interface, the source
1927 address of the packet is entered into the address cache as being a
1928 destination address on the interface's segment.
1929 This is the default for all interfaces added to a bridge.
1930 .It Cm -learn Ar interface
1933 attribute on a member interface.
1934 .It Cm sticky Ar interface
1935 Mark an interface as a
1938 Dynamically learned address entries are treated at static once entered into
1940 Sticky entries are never aged out of the cache or replaced, even if the
1941 address is seen on a different interface.
1942 .It Cm -sticky Ar interface
1945 attribute on a member interface.
1946 .It Cm private Ar interface
1947 Mark an interface as a
1950 A private interface does not forward any traffic to any other port that is also
1951 a private interface.
1952 .It Cm -private Ar interface
1955 attribute on a member interface.
1956 .It Cm span Ar interface
1957 Add the interface named by
1959 as a span port on the bridge.
1960 Span ports transmit a copy of every frame received by the bridge.
1961 This is most useful for snooping a bridged network passively on
1962 another host connected to one of the span ports of the bridge.
1963 .It Cm -span Ar interface
1964 Delete the interface named by
1966 from the list of span ports of the bridge.
1967 .It Cm stp Ar interface
1968 Enable Spanning Tree protocol on
1972 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1973 Spanning Tree is used to detect and remove loops in a network topology.
1974 .It Cm -stp Ar interface
1975 Disable Spanning Tree protocol on
1977 This is the default for all interfaces added to a bridge.
1978 .It Cm edge Ar interface
1982 An edge port connects directly to end stations cannot create bridging
1983 loops in the network, this allows it to transition straight to forwarding.
1984 .It Cm -edge Ar interface
1985 Disable edge status on
1987 .It Cm autoedge Ar interface
1990 to automatically detect edge status.
1991 This is the default for all interfaces added to a bridge.
1992 .It Cm -autoedge Ar interface
1993 Disable automatic edge status on
1995 .It Cm ptp Ar interface
1998 as a point to point link.
1999 This is required for straight transitions to forwarding and
2000 should be enabled on a direct link to another RSTP capable switch.
2001 .It Cm -ptp Ar interface
2002 Disable point to point link status on
2004 This should be disabled for a half duplex link and for an interface
2005 connected to a shared network segment,
2006 like a hub or a wireless network.
2007 .It Cm autoptp Ar interface
2008 Automatically detect the point to point status on
2010 by checking the full duplex link status.
2011 This is the default for interfaces added to the bridge.
2012 .It Cm -autoptp Ar interface
2013 Disable automatic point to point link detection on
2015 .It Cm maxage Ar seconds
2016 Set the time that a Spanning Tree protocol configuration is valid.
2017 The default is 20 seconds.
2018 The minimum is 6 seconds and the maximum is 40 seconds.
2019 .It Cm fwddelay Ar seconds
2020 Set the time that must pass before an interface begins forwarding
2021 packets when Spanning Tree is enabled.
2022 The default is 15 seconds.
2023 The minimum is 4 seconds and the maximum is 30 seconds.
2024 .It Cm hellotime Ar seconds
2025 Set the time between broadcasting of Spanning Tree protocol
2026 configuration messages.
2027 The hello time may only be changed when operating in legacy stp mode.
2028 The default is 2 seconds.
2029 The minimum is 1 second and the maximum is 2 seconds.
2030 .It Cm priority Ar value
2031 Set the bridge priority for Spanning Tree.
2032 The default is 32768.
2033 The minimum is 0 and the maximum is 61440.
2034 .It Cm proto Ar value
2035 Set the Spanning Tree protocol.
2036 The default is rstp.
2037 The available options are stp and rstp.
2038 .It Cm holdcnt Ar value
2039 Set the transmit hold count for Spanning Tree.
2040 This is the number of packets transmitted before being rate limited.
2042 The minimum is 1 and the maximum is 10.
2043 .It Cm ifpriority Ar interface Ar value
2044 Set the Spanning Tree priority of
2049 The minimum is 0 and the maximum is 240.
2050 .It Cm ifpathcost Ar interface Ar value
2051 Set the Spanning Tree path cost of
2055 The default is calculated from the link speed.
2056 To change a previously selected path cost back to automatic, set the
2058 The minimum is 1 and the maximum is 200000000.
2059 .It Cm ifmaxaddr Ar interface Ar size
2060 Set the maximum number of hosts allowed from an interface, packets with unknown
2061 source addresses are dropped until an existing host cache entry expires or is
2063 Set to 0 to disable.
2066 The following parameters are specific to lagg interfaces:
2067 .Bl -tag -width indent
2068 .It Cm laggport Ar interface
2069 Add the interface named by
2071 as a port of the aggregation interface.
2072 .It Cm -laggport Ar interface
2073 Remove the interface named by
2075 from the aggregation interface.
2076 .It Cm laggproto Ar proto
2077 Set the aggregation protocol.
2078 The default is failover.
2079 The available options are failover, fec, lacp, loadbalance, roundrobin and
2083 The following parameters are specific to IP tunnel interfaces,
2085 .Bl -tag -width indent
2086 .It Cm tunnel Ar src_addr dest_addr
2087 Configure the physical source and destination address for IP tunnel
2093 are interpreted as the outer source/destination for the encapsulating
2096 Unconfigure the physical source and destination address for IP tunnel
2097 interfaces previously configured with
2100 Another name for the
2105 The following parameters are specific to GRE tunnel interfaces,
2107 .Bl -tag -width indent
2108 .It Cm grekey Ar key
2109 Configure the GRE key to be used for outgoing packets.
2111 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2112 This command will result in a four byte MTU reduction on the interface.
2115 The following parameters are specific to
2118 .Bl -tag -width indent
2120 Set the maximum number of updates for a single state which
2121 can be collapsed into one.
2122 This is an 8-bit number; the default value is 128.
2125 The following parameters are specific to
2128 .Bl -tag -width indent
2129 .It Cm vlan Ar vlan_tag
2130 Set the VLAN tag value to
2132 This value is a 16-bit number which is used to create an 802.1Q
2133 VLAN header for packets sent from the
2140 must both be set at the same time.
2141 .It Cm vlandev Ar iface
2142 Associate the physical interface
2147 Packets transmitted through the
2150 diverted to the specified physical interface
2152 with 802.1Q VLAN encapsulation.
2153 Packets with 802.1Q encapsulation received
2154 by the parent interface with the correct VLAN tag will be diverted to
2160 interface is assigned a
2161 copy of the parent interface's flags and the parent's ethernet address.
2166 must both be set at the same time.
2169 interface already has
2170 a physical interface associated with it, this command will fail.
2172 change the association to another physical interface, the existing
2173 association must be cleared first.
2175 Note: if the hardware tagging capability
2176 is set on the parent interface, the
2179 interface's behavior changes:
2182 interface recognizes that the
2183 parent interface supports insertion and extraction of VLAN tags on its
2184 own (usually in firmware) and that it should pass packets to and from
2185 the parent unaltered.
2186 .It Fl vlandev Op Ar iface
2189 pseudo device, disassociate the parent interface from it.
2190 This breaks the link between the
2192 interface and its parent,
2193 clears its VLAN tag, flags and its link address and shuts the interface down.
2196 argument is useless and hence deprecated.
2199 The following parameters are specific to
2202 .Bl -tag -width indent
2203 .It Cm advbase Ar seconds
2204 Specifies the base of the advertisement interval in seconds.
2205 The acceptable values are 1 to 255.
2206 The default value is 1.
2207 .\" The default value is
2208 .\" .Dv CARP_DFLTINTV .
2209 .It Cm advskew Ar interval
2210 Specifies the skew to add to the base advertisement interval to
2211 make one host advertise slower than another host.
2212 It is specified in 1/256 of seconds.
2213 The acceptable values are 1 to 254.
2214 The default value is 0.
2215 .It Cm pass Ar phrase
2216 Set the authentication key to
2219 Set the virtual host ID.
2220 This is a required setting.
2221 Acceptable values are 1 to 255.
2226 utility displays the current configuration for a network interface
2227 when no optional parameters are supplied.
2228 If a protocol family is specified,
2230 will report only the details specific to that protocol family.
2234 flag is passed before an interface name,
2236 will display the capability list and all
2237 of the supported media for the specified interface.
2240 flag is supplied, address lifetime is displayed for IPv6 addresses,
2241 as time offset string.
2245 flag may be used instead of an interface name.
2248 to display information about all interfaces in the system.
2251 flag limits this to interfaces that are down, and
2253 limits this to interfaces that are up.
2254 When no arguments are given,
2260 flag may be used to list all available interfaces on the system, with
2261 no other additional information.
2262 Use of this flag is mutually exclusive
2263 with all other flags and commands, except for
2265 (only list interfaces that are down)
2268 (only list interfaces that are up).
2272 flag may be used to get more verbose status for an interface.
2276 flag may be used to list all of the interface cloners available on
2277 the system, with no additional information.
2278 Use of this flag is mutually exclusive with all other flags and commands.
2282 flag causes keying information for the interface, if available, to be
2284 For example, the values of 802.11 WEP keys will be printed, if accessible to
2286 This information is not printed by default, as it may be considered
2289 If the network interface driver is not present in the kernel then
2291 will attempt to load it.
2294 flag disables this behavior.
2296 Only the super-user may modify the configuration of a network interface.
2298 The media selection system is relatively new and only some drivers support
2299 it (or have need for it).
2301 Assign the IPv4 address
2303 with a network mask of
2307 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2309 Add the IPv4 address
2311 with the CIDR network prefix
2317 as a synonym for the canonical form of the option
2319 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2321 Remove the IPv4 address
2325 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2327 Add the IPv6 address
2328 .Li 2001:DB8:DBDB::123/48
2331 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2332 Note that lower case hexadecimal IPv6 addresses are acceptable.
2334 Remove the IPv6 address added in the above example,
2337 character as shorthand for the network prefix,
2340 as a synonym for the canonical form of the option
2342 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2344 Configure the interface
2346 to use 100baseTX, full duplex Ethernet media options:
2347 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2349 Create the software network interface
2351 .Dl # ifconfig gif1 create
2353 Destroy the software network interface
2355 .Dl # ifconfig gif1 destroy
2357 Messages indicating the specified interface does not exist, the
2358 requested address is unknown, or the user is not privileged and
2359 tried to alter an interface's configuration.
2377 Basic IPv6 node operation requires a link-local address on each
2378 interface configured for IPv6.
2379 Normally, such an address is automatically configured by the
2380 kernel on each interface added to the system; this behaviour may
2381 be disabled by setting the sysctl MIB variable
2382 .Va net.inet6.ip6.auto_linklocal
2385 If you delete such an address using
2387 the kernel may act very odd.
2388 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob