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.
615 The operating mode of a cloned interface cannot be changed.
616 .It Cm wlanbssid Ar bssid
617 The 802.11 mac address to use for the bssid.
618 This must be specified at create time for a legacy
621 .It Cm wlanaddr Ar address
622 The local mac address.
623 If this is not specified then a mac address will automatically be assigned
624 to the cloned device.
625 Typically this address is the same as the address of the parent device
628 parameter is specified then the driver will craft a unique address for
629 the device (if supported).
633 device as operating in ``legacy mode''.
636 devices have a fixed peer relationship and do not, for example, roam
637 if their peer stops communicating.
638 For completeness a Dynamic WDS (DWDS) interface may marked as
641 Request a unique local mac address for the cloned device.
642 This is only possible if the device supports multiple mac addresses.
643 To force use of the parent's mac address use
646 Mark the cloned interface as depending on hardware support to
647 track received beacons.
648 To have beacons tracked in software use
654 can also be used to indicate no beacons should
655 be transmitted; this can be useful when creating a WDS configuration but
657 interfaces can only be created as companions to an access point.
660 The following parameters are specific to IEEE 802.11 wireless interfaces
664 .Bl -tag -width indent
666 Enable sending and receiving AMPDU frames when using 802.11n (default).
667 The 802.11n specification states a compliant station must be capable
668 of receiving AMPDU frames but transmision is optional.
671 to disable all use of AMPDU with 802.11n.
672 For testing and/or to work around interoperability problems one can use
676 to control use of AMPDU in one direction.
677 .It Cm ampdudensity Ar density
678 Set the AMPDU density parameter used when operating with 802.11n.
679 This parameter controls the inter-packet gap for AMPDU frames.
680 The sending device normally controls this setting but a receiving station
681 may request wider gaps.
684 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
687 is treated the same as 0.
688 .It Cm ampdulimit Ar limit
689 Set the limit on packet size for receiving AMPDU frames when operating
693 are 8192, 16384, 32768, and 65536 but one can also specify
694 just the unique prefix: 8, 16, 32, 64.
695 Note the sender may limit the size of AMPDU frames to be less
696 than the maximum specified by the receiving station.
698 Enable sending and receiving AMSDU frames when using 802.11n.
699 By default AMSDU is received but not transmitted.
702 to disable all use of AMSDU with 802.11n.
703 For testing and/or to work around interoperability problems one can use
707 to control use of AMSDU in one direction.
708 .It Cm amsdulimit Ar limit
709 Set the limit on packet size for sending and receiving AMSDU frames
710 when operating with 802.11n.
713 are 7935 and 3839 (bytes).
714 Note the sender may limit the size of AMSDU frames to be less
715 than the maximum specified by the receiving station.
716 Note also that devices are not required to support the 7935 limit,
717 only 3839 is required by the specification and the larger value
718 may require more memory to be dedicated to support functionality
721 When operating as an access point, pass packets between
722 wireless clients directly (default).
723 To instead let them pass up through the
724 system and be forwarded using some other mechanism, use
726 Disabling the internal bridging
727 is useful when traffic is to be processed with
729 .It Cm authmode Ar mode
730 Set the desired authentication mode in infrastructure mode.
731 Not all adapters support all modes.
734 .Cm none , open , shared
740 (IEEE WPA/WPA2/802.11i).
745 modes are only useful when using an authentication service
746 (a supplicant for client operation or an authenticator when
747 operating as an access point).
748 Modes are case insensitive.
750 Enable background scanning when operating as a station.
751 Background scanning is a technique whereby a station associated to
752 an access point will temporarily leave the channel to scan for
753 neighboring stations.
754 This allows a station to maintain a cache of nearby access points
755 so that roaming between access points can be done without
756 a lengthy scan operation.
757 Background scanning is done only when a station is not busy and
758 any outbound traffic will cancel a scan operation.
759 Background scanning should never cause packets to be lost though
760 there may be some small latency if outbound traffic interrupts a
762 By default background scanning is enabled if the device is capable.
763 To disable background scanning, use
765 Background scanning is controlled by the
770 Background scanning must be enabled for roaming; this is an artifact
771 of the current implementation and may not be required in the future.
772 .It Cm bgscanidle Ar idletime
773 Set the minimum time a station must be idle (not transmitting or
774 receiving frames) before a background scan is initiated.
777 parameter is specified in milliseconds.
778 By default a station must be idle at least 250 milliseconds before
779 a background scan is initiated.
780 The idle time may not be set to less than 100 milliseconds.
781 .It Cm bgscanintvl Ar interval
782 Set the interval at which background scanning is attempted.
785 parameter is specified in seconds.
786 By default a background scan is considered every 300 seconds (5 minutes).
789 may not be set to less than 15 seconds.
790 .It Cm bintval Ar interval
791 Set the interval at which beacon frames are sent when operating in
795 parameter is specified in TU's (1024 usecs).
796 By default beacon frames are transmitted every 100 TU's.
797 .It Cm bmissthreshold Ar count
798 Set the number of consecutive missed beacons at which the station
799 will attempt to roam (i.e., search for a new access point).
802 parameter must be in the range 1 to 255; though the
803 upper bound may be reduced according to device capabilities.
804 The default threshold is 7 consecutive missed beacons; but
805 this may be overridden by the device driver.
810 .It Cm bssid Ar address
811 Specify the MAC address of the access point to use when operating
812 as a station in a BSS network.
813 This overrides any automatic selection done by the system.
814 To disable a previously selected access point, supply
819 This option is useful when more than one access point uses the same SSID.
825 Enable packet bursting.
826 Packet bursting is a transmission technique whereby the wireless
827 medium is acquired once to send multiple frames and the interframe
829 This technique can significantly increase throughput by reducing
830 transmission overhead.
831 Packet bursting is supported by the 802.11e QoS specification
832 and some devices that do not support QoS may still be capable.
833 By default packet bursting is enabled if a device is capable
835 To disable packet bursting, use
837 .It Cm chanlist Ar channels
838 Set the desired channels to use when scanning for access
839 points, neighbors in an IBSS network, or looking for unoccupied
840 channels when operating as an access point.
841 The set of channels is specified as a comma-separated list with
842 each element in the list representing either a single channel number or a range
845 Channel numbers must be in the range 1 to 255 and be permissible
846 according to the operating characteristics of the device.
847 .It Cm channel Ar number
848 Set a single desired channel.
849 Channels range from 1 to 255, but the exact selection available
850 depends on the region your adaptor was manufactured for.
856 will clear any desired channel and, if the device is marked up,
857 force a scan for a channel to operate on.
858 Alternatively the frequency, in megahertz, may be specified
859 instead of the channel number.
861 When there are several ways to use a channel the channel
862 number/frequency may be appended with attributes to clarify.
863 For example, if a device is capable of operating on channel 6
864 with 802.11n and 802.11g then one can specify that g-only use
865 should be used by specifying ``6:g''.
866 Similarly the channel width can be specified by appending it
867 with ``/''; e.g. ``6/40'' specifies a 40MHz wide channel,
868 These attributes can be combined as in: ``6:ht/40''.
869 The full set of flags specified following a `:'' are:
875 (Atheros Dynamic Turbo mode),
883 (Atheros Static Turbo mode),
886 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
887 The full set of channel widths following a '/' are:
889 (5MHz aka quarter-rate channel),
891 (10MHz aka half-rate channel),
893 (20MHz mostly for use in specifying ht20),
896 (40MHz mostly for use in specifying ht40),
898 a 40MHz HT channel specification may include the location
899 of the extension channel by appending ``+'' or ``-'' for above and below,
900 respectively; e.g. ``2437:ht/40+'' specifies 40MHz wide HT operation
901 with the center channel at frequency 2437 and the extension channel above.
902 .It Cm country Ar name
903 Set the country code to use in calculating the regulatory constraints
905 In particular the set of available channels, how the wireless device
906 will operation on the channels, and the maximum transmit power that
907 can be used on a channel are defined by this setting.
908 Country/Region codes are specified as a 2-character abbreviation
909 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
910 e.g. "ES" and "Spain".
911 The set of country codes are taken from /etc/regdomain.xml and can also
912 be viewed with the ``list countries'' request.
913 Note that not all devices support changing the country code from a default
914 setting; typically stored in EEPROM.
922 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
923 DFS embodies several facilities including detection of overlapping
924 radar signals, dynamic transmit power control, and channel selection
925 according to a least-congested criteria.
926 DFS support is mandatory for some 5Ghz frequencies in certain
928 By default DFS is enabled according to the regulatory definitions
929 specified in /etc/regdomain.xml and the curent country code, regdomain,
931 Note the underlying device (and driver) must support radar detection
932 for full DFS support to work.
933 To be fully compliant with the local regulatory agency frequencies that
934 require DFS should not be used unless it is fully supported.
937 to disable this functionality for testing.
939 Enable support for the 802.11d specification (default).
940 When this support is enabled in station mode, beacon frames that advertise
941 a country code different than the currently configured country code will
942 cause an event to be dispatched to user applications.
943 This event can be used by the station to adopt that country code and
944 operate according to the associated regulatory constraints.
945 When operating as an access point with 802.11d enabled the beacon and
946 probe response frames transmitted will advertise the current regulatory
948 To disable 802.11d use
951 Enable 802.11h support including spectrum management.
952 When 802.11h is enabled beacon and probe response frames will have
953 the SpectrumMgt bit set in the capabilities field and
954 country and power constraint information elements will be present.
955 802.11h support also includes handling Channel Switch Announcements (CSA)
956 which are a mechanism to coordinate channel changes by an access point.
957 By default 802.11h is enabled if the device is capable.
958 To disable 802.11h use
960 .It Cm deftxkey Ar index
961 Set the default key to use for transmission.
962 Typically this is only set when using WEP encryption.
963 Note that you must set a default transmit key
964 for the system to know which key to use in encrypting outbound traffic.
967 is an alias for this request; it is provided for backwards compatibility.
968 .It Cm dtimperiod Ar period
971 period for transmitting buffered multicast data frames when
972 operating in ap mode.
975 specifies the number of beacon intervals between DTIM
976 and must be in the range 1 to 15.
977 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
979 Enable the use of Atheros Dynamic Turbo mode when communicating with
980 another Dynamic Turbo-capable station.
981 Dynamic Turbo mode is an Atheros-specific mechanism by which
982 stations switch between normal 802.11 operation and a ``boosted''
983 mode in which a 40MHz wide channel is used for communication.
984 Stations using Dynamic Turbo mode operate boosted only when the
985 channel is free of non-dturbo stations; when a non-dturbo station
986 is identified on the channel all stations will automatically drop
987 back to normal operation.
988 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
989 Note that turbo mode (dynamic or static) is only allowed on some
990 channels depending on the regulatory constraints; use the
992 command to identify the channels where turbo mode may be used.
993 To disable Dynamic Turbo mode use
996 Enable Dynamic WDS (DWDS) support.
997 DWDS is a facility by which 4-address traffic can be carried between
998 stations operating in infrastructure mode.
999 A station first associates to an access point and authenticates using
1000 normal procedures (e.g. WPA).
1001 Then 4-address frames are passed to carry traffic for stations
1002 operating on either side of the wireless link.
1003 DWDS extends the normal WDS mechanism by leveraging existing security
1004 protocols and eliminating static binding.
1006 When DWDS is enabled on an access point 4-address frames received from
1007 an authorized station will generate a ``DWDS discovery'' event to user
1009 This event should be used to create a WDS interface that is bound
1010 to the remote station (and usually plumbed into a bridge).
1011 Once the WDS interface is up and running 4-address traffic then logically
1012 flows through that interface.
1014 When DWDS is enabled on a station, traffic with a destination address
1015 different from the peer station are encapsulated in a 4-address frame
1016 and transmitted to the peer.
1017 All 4-address traffic uses the security information of the stations
1018 (e.g. cryptographic keys).
1019 A station is associated using 802.11n facilities may transport
1020 4-address traffic using these same mechanisms; this depends on available
1021 resources and capabilities of the device.
1022 The DWDS implementation guards against layer 2 routing loops of
1025 Enable the use of Atheros Fast Frames when communicating with
1026 another Fast Frames-capable station.
1027 Fast Frames are an encapsulation technique by which two 802.3
1028 frames are transmitted in a single 802.11 frame.
1029 This can noticeably improve throughput but requires that the
1030 receiving station understand how to decapsulate the frame.
1031 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1032 protocol extension so enabling use is safe when communicating with
1033 non-Atheros devices.
1034 By default, use of fast frames is enabled if the device is capable.
1035 To explicitly disable fast frames, use
1037 .It Cm fragthreshold Ar length
1038 Set the threshold for which transmitted frames are broken into fragments.
1041 argument is the frame size in bytes and must be in the range 256 to 2346.
1049 disables transmit fragmentation.
1050 Not all adapters honor the fragmentation threshold.
1052 When operating as an access point, do not broadcast the SSID
1053 in beacon frames or respond to probe request frames unless
1054 they are directed to the ap (i.e., they include the ap's SSID).
1055 By default, the SSID is included in beacon frames and
1056 undirected probe request frames are answered.
1057 To re-enable the broadcast of the SSID etc., use
1060 Enable use of High Throughput (HT) when using 802.11n (default).
1061 The 802.11n specification includes mechanisms for operation
1062 on 20MHz and 40MHz wide channels using different signalling mechanisms
1063 than specified in 802.11b, 802.11g, and 802.11a.
1064 Stations negotiate use of these facilities, termed HT20 and HT40,
1065 when they associate.
1066 To disable all use of 802.11n use
1068 To disable use of HT20 (e.g. to force only HT40 use) use
1070 To disable use of HT40 use
1073 HT configuration is used to ``auto promote'' operation
1074 when several choices are available.
1075 For example, if a station associates to an 11n-capable access point
1076 it controls whether the station uses legacy operation, HT20, or HT40.
1077 When an 11n-capable device is setup as an access point and
1078 Auto Channel Selection is used to locate a channel to operate on,
1079 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1080 on the selected channel.
1081 If a fixed channel is specified for a station then HT configuration can
1082 be given as part of the channel specification; e.g. 6:ht/20 to setup
1083 HT20 operation on channel 6.
1085 Enable use of compatibility support for pre-802.11n devices (default).
1086 The 802.11n protocol specification went through several incompatible iterations.
1087 Some vendors implemented 11n support to older specifications that
1088 will not interoperate with a purely 11n-compliant station.
1089 In particular the information elements included in management frames
1090 for old devices are different.
1091 When compatibility support is enabled both standard and compatible data
1093 Stations that associate using the compatiblity mechanisms are flagged
1095 To disable compatiblity support use
1097 .It Cm htprotmode Ar technique
1098 For interfaces operating in 802.11n, use the specified
1100 for protecting HT frames in a mixed legacy/HT network.
1101 The set of valid techniques is
1106 Technique names are case insensitive.
1108 Enable inactivity processing for stations associated to an
1109 access point (default).
1110 When operating as an access point the 802.11 layer monitors
1111 the activity of each associated station.
1112 When a station is inactive for 5 minutes it will send several
1113 ``probe frames'' to see if the station is still present.
1114 If no response is received then the station is deauthenticated.
1115 Applications that prefer to handle this work can disable this
1119 Set the location to use in calculating regulatory constraints.
1120 The location is also advertised in beacon and probe response frames
1121 when 802.11d is enabled with
1130 Display the list of channels available for use taking into account
1131 any restrictions set with the
1134 See the description of
1136 for more information.
1138 Display the adaptor's capabilities, including the operating
1141 Display the list of channels available for use.
1142 Channels are shown with their IEEE channel number, equivalent
1143 frequency, and usage modes.
1144 Channels identified as
1149 Channels identified as
1151 may be used only for Atheros' Static Turbo mode
1153 . Cm mediaopt turbo ) .
1154 Channels marked with a
1156 have a regulatory constraint that they be passively scanned.
1157 This means a station is not permitted to transmit on the channel until
1158 it identifies the channel is being used for 802.11 communication;
1159 typically by hearing a beacon frame from an access point operating
1162 is another way of requesting this information.
1163 By default a compacted list of channels is displayed; if the
1165 option is specified then all channels are shown.
1166 .It Cm list countries
1167 Display the set of country codes and regulatory domains that can be
1168 used in regulatory configuration.
1170 Display the current MAC Access Control List state.
1171 Each address is prefixed with a character that indicates the
1172 current policy applied to it:
1174 indicates the address is allowed access,
1176 indicates the address is denied access,
1178 indicates the address is present but the current policy open
1179 (so the ACL is not consulted).
1180 .It Cm list regdomain
1181 Display the current regulatory settings including the available channels
1182 and transmit power caps.
1184 Display the parameters that govern roaming operation.
1186 Display the parameters that govern transmit operation.
1188 Display the transmit power caps for each channel.
1190 Display the access points and/or ad-hoc neighbors
1191 located in the vicinity.
1192 This information may be updated automatically by the adapter
1195 request or through background scanning.
1196 Depending on the capabilities of the stations the following
1197 flags can be included in the output:
1201 Indicates that the station is permitted to send/receive data frames.
1203 Extended Rate Phy (ERP).
1204 Indicates that the station is operating in an 802.11g network
1205 using extended transmit rates.
1207 High Throughput (HT).
1208 Indicates that the station is using HT transmit rates.
1209 If a `+' follows immediately after then the station associated
1210 using deprecated mechanisms supported only when
1215 Indicates that the station is operating in power save mode.
1217 Quality of Service (QoS).
1218 Indicates that the station is using QoS encapsulation for
1220 QoS encapsulation is enabled only when WME mode is enabled.
1222 Transitional Security Network (TSN).
1223 Indicates that the station associated using TSN; see also
1227 Wi-Fi Protected Setup (WPS).
1228 Indicates that the station associated using WPS.
1231 By default interesting information elements captured from the neighboring
1232 stations are displayed at the end of each row.
1233 Possible elements include:
1235 (station supports WME),
1237 (station supports WPA),
1239 (station supports WPS),
1241 (station supports 802.11i/RSN),
1243 (station supports 802.11n/HT communication),
1245 (station supports Atheros protocol extensions),
1247 (station supports unknown vendor-specific extensions).
1250 flag is used all the information elements and their
1251 contents will be shown.
1254 flag also enables display of long SSIDs.
1256 is another way of requesting this information.
1258 When operating as an access point display the stations that are
1259 currently associated.
1260 When operating in ad-hoc mode display stations identified as
1261 neighbors in the IBSS.
1262 When operating in station mode display the access point.
1263 Capabilities advertised by the stations are described under
1267 Depending on the capabilities of the stations the following
1268 flags can be included in the output:
1272 Indicates that the station is permitted to send/receive data frames.
1274 Extended Rate Phy (ERP).
1275 Indicates that the station is operating in an 802.11g network
1276 using extended transmit rates.
1278 High Throughput (HT).
1279 Indicates that the station is using HT transmit rates.
1280 If a `+' follows immediately after then the station associated
1281 using deprecated mechanisms supported only when
1286 Indicates that the station is operating in power save mode.
1288 Quality of Service (QoS).
1289 Indicates that the station is using QoS encapsulation for
1291 QoS encapsulation is enabled only when WME mode is enabled.
1293 Transitional Security Network (TSN).
1294 Indicates that the station associated using TSN; see also
1298 Wi-Fi Protected Setup (WPS).
1299 Indicates that the station associated using WPS.
1302 By default information elements received from associated stations
1303 are displayed in a short form; the
1305 flag causes this information to be displayed symbolically.
1307 Display the current channel parameters to use when operating in WME mode.
1310 option is specified then both channel and BSS parameters are displayed
1311 for each AC (first channel, then BSS).
1312 When WME mode is enabled for an adaptor this information will be
1313 displayed with the regular status; this command is mostly useful
1314 for examining parameters when WME mode is disabled.
1315 See the description of the
1317 directive for information on the various parameters.
1318 .It Cm maxretry Ar count
1319 Set the maximum number of tries to use in sending unicast frames.
1320 The default setting is 6 but drivers may override this with a value
1322 .It Cm mcastrate Ar rate
1323 Set the rate for transmitting multicast/broadcast frames.
1324 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1325 This rate should be valid for the current operating conditions;
1326 if an invalid rate is specified drivers are free to chose an
1328 .It Cm mgtrate Ar rate
1329 Set the rate for transmitting management and/or control frames.
1330 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1332 Set the location to use in calculating regulatory constraints.
1333 The location is also advertised in beacon and probe response frames
1334 when 802.11d is enabled with
1343 Enable powersave operation.
1344 When operating as a client, the station will conserve power by
1345 periodically turning off the radio and listening for
1346 messages from the access point telling it there are packets waiting.
1347 The station must then retrieve the packets.
1348 Not all devices support power save operation as a client.
1349 The 802.11 specification requires that all access points support
1350 power save but some drivers do not.
1353 to disable powersave operation when operating as a client.
1354 .It Cm powersavesleep Ar sleep
1355 Set the desired max powersave sleep time in TU's (1024 usecs).
1356 By default the max powersave sleep time is 100 TU's.
1357 .It Cm protmode Ar technique
1358 For interfaces operating in 802.11g, use the specified
1360 for protecting OFDM frames in a mixed 11b/11g network.
1361 The set of valid techniques is
1367 Technique names are case insensitive.
1368 Not all devices support
1370 as a protection technique.
1372 When operating as an access point in 802.11g mode allow only
1373 11g-capable stations to associate (11b-only stations are not
1374 permitted to associate).
1375 To allow both 11g and 11b-only stations to associate, use
1378 When operating as an access point in 802.11n mode allow only
1379 HT-capable stations to associate (legacy stations are not
1380 permitted to associate).
1381 To allow both HT and legacy stations to associate, use
1383 .It Cm regdomain Ar sku
1384 Set the regulatory domain to use in calculating the regulatory constraints
1386 In particular the set of available channels, how the wireless device
1387 will operation on the channels, and the maximum transmit power that
1388 can be used on a channel are defined by this setting.
1389 Regdomain codes (SKU's) are taken from /etc/regdomain.xml and can also
1390 be viewed with the ``list countries'' request.
1391 Note that not all devices support changing the regdomain from a default
1392 setting; typically stored in EEPROM.
1400 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1402 Note that RIFS must be supported by both the station and access point
1406 .It Cm roam:rate Ar rate
1407 Set the threshold for controlling roaming when operating in a BSS.
1410 parameter specifies the transmit rate in megabits
1411 at which roaming should be considered.
1412 If the current transmit rate drops below this setting and background scanning
1413 is enabled, then the system will check if a more desirable access point is
1414 available and switch over to it.
1415 The current scan cache contents are used if they are considered
1416 valid according to the
1418 parameter; otherwise a background scan operation is triggered before
1419 any selection occurs.
1420 Each channel type has a separate rate threshold; the default values are:
1421 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1422 .It Cm roam:rssi Ar rssi
1423 Set the threshold for controlling roaming when operating in a BSS.
1426 parameter specifies the receive signal strength in dBm units
1427 at which roaming should be considered.
1428 If the current rssi drops below this setting and background scanning
1429 is enabled, then the system will check if a more desirable access point is
1430 available and switch over to it.
1431 The current scan cache contents are used if they are considered
1432 valid according to the
1434 parameter; otherwise a background scan operation is triggered before
1435 any selection occurs.
1436 Each channel type has a separate rssi threshold; the default values are
1438 .It Cm roaming Ar mode
1439 When operating as a station, control how the system will
1440 behave when communication with the current access point
1444 argument may be one of
1446 (leave it to the hardware device to decide),
1448 (handle either in the device or the operating system\[em]as appropriate),
1450 (do nothing until explicitly instructed).
1451 By default, the device is left to handle this if it is
1452 capable; otherwise, the operating system will automatically
1453 attempt to reestablish communication.
1454 Manual mode is used by applications such as
1455 .Xr wpa_supplicant 8
1456 that want to control the selection of an access point.
1457 .It Cm rtsthreshold Ar length
1458 Set the threshold for which
1459 transmitted frames are preceded by transmission of an
1465 is the frame size in bytes and must be in the range 1 to 2346.
1473 disables transmission of RTS frames.
1474 Not all adapters support setting the RTS threshold.
1476 Initiate a scan of neighboring stations, wait for it to complete, and
1477 display all stations found.
1478 Only the super-user can initiate a scan.
1481 for information on the display.
1482 By default a background scan is done; otherwise a foreground
1483 scan is done and the station may roam to a different access point.
1486 request can be used to show recent scan results without
1487 initiating a new scan.
1488 .It Cm scanvalid Ar threshold
1489 Set the maximum time the scan cache contents are considered valid;
1490 i.e. will be used without first triggering a scan operation to
1494 parameter is specified in seconds and defaults to 60 seconds.
1495 The minimum setting for
1498 One should take care setting this threshold; if it is set too low
1499 then attempts to roam to another access point may trigger unnecessary
1500 background scan operations.
1502 Enable use of Short Guard Interval when operating in 802.11n
1504 NB: this currently enables Short GI on both HT40 and HT20 channels.
1505 To disable Short GI use
1508 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1509 when operating in 802.11n.
1510 A station operating with Static SMPS maintains only a single
1511 receive chain active (this can significantly reduce power consumption).
1515 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1516 when operating in 802.11n.
1517 A station operating with Dynamic SMPS maintains only a single
1518 receive chain active but switches to multiple receive chains when it
1519 receives an RTS frame (this can significantly reduce power consumption).
1520 Note that stations cannot distinguish between RTS/CTS intended to
1521 enable multiple receive chains and those used for other purposes.
1525 Set the desired Service Set Identifier (aka network name).
1526 The SSID is a string up to 32 characters
1527 in length and may be specified as either a normal string or in
1528 hexadecimal when preceded by
1530 Additionally, the SSID may be cleared by setting it to
1533 When operating as an access point with WPA/802.11i allow legacy
1534 stations to associate using static key WEP and open authentication.
1535 To disallow legacy station use of WEP, use
1537 .It Cm txpower Ar power
1538 Set the power used to transmit frames.
1541 argument is specified in .5 dBm units.
1542 Out of range values are truncated.
1543 Typically only a few discreet power settings are available and
1544 the driver will use the setting closest to the specified value.
1545 Not all adapters support changing the transmit power.
1546 .It Cm ucastrate Ar rate
1547 Set a fixed rate for transmitting unicast frames.
1548 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mb/s.
1549 This rate should be valid for the current operating conditions;
1550 if an invalid rate is specified drivers are free to chose an
1552 .It Cm wepmode Ar mode
1553 Set the desired WEP mode.
1554 Not all adapters support all modes.
1555 The set of valid modes is
1561 mode explicitly tells the adaptor to allow association with access
1562 points which allow both encrypted and unencrypted traffic.
1565 means that the access point must only allow encrypted connections.
1568 is generally another name for
1570 Modes are case insensitive.
1571 .It Cm weptxkey Ar index
1572 Set the WEP key to be used for transmission.
1573 This is the same as setting the default transmission key with
1575 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1576 Set the selected WEP key.
1579 is not given, key 1 is set.
1580 A WEP key will be either 5 or 13
1581 characters (40 or 104 bits) depending of the local network and the
1582 capabilities of the adaptor.
1583 It may be specified either as a plain
1584 string or as a string of hexadecimal digits preceded by
1586 For maximum portability, hex keys are recommended;
1587 the mapping of text keys to WEP encryption is usually driver-specific.
1590 drivers do this mapping differently to
1592 A key may be cleared by setting it to
1594 If WEP is supported then there are at least four keys.
1595 Some adapters support more than four keys.
1596 If that is the case, then the first four keys
1597 (1-4) will be the standard temporary keys and any others will be adaptor
1598 specific keys such as permanent keys stored in NVRAM.
1600 Note that you must set a default transmit key with
1602 for the system to know which key to use in encrypting outbound traffic.
1604 Enable Wireless Multimedia Extensions (WME) support, if available,
1605 for the specified interface.
1606 WME is a subset of the IEEE 802.11e standard to support the
1607 efficient communication of realtime and multimedia data.
1608 To disable WME support, use
1610 Another name for this parameter is
1613 The following parameters are meaningful only when WME support is in use.
1614 Parameters are specified per-AC (Access Category) and
1615 split into those that are used by a station when acting
1616 as an access point and those for client stations in the BSS.
1617 The latter are received from the access point and may not be changed
1619 The following Access Categories are recognized:
1621 .Bl -tag -width ".Cm AC_BK" -compact
1625 best effort delivery,
1640 AC parameters are case-insensitive.
1641 Traffic classification is done in the operating system using the
1642 vlan priority associated with data frames or the
1643 ToS (Type of Service) indication in IP-encapsulated frames.
1644 If neither information is present, traffic is assigned to the
1645 Best Effort (BE) category.
1646 .Bl -tag -width indent
1648 Set the ACK policy for QoS transmissions by the local station;
1649 this controls whether or not data frames transmitted by a station
1650 require an ACK response from the receiving station.
1651 To disable waiting for an ACK use
1653 This parameter is applied only to the local station.
1655 Enable the Admission Control Mandatory (ACM) mechanism
1656 for transmissions by the local station.
1657 To disable the ACM use
1659 On stations in a BSS this parameter is read-only and indicates
1660 the setting received from the access point.
1661 NB: ACM is not supported right now.
1662 .It Cm aifs Ar ac Ar count
1663 Set the Arbitration Inter Frame Spacing (AIFS)
1664 channel access parameter to use for transmissions
1665 by the local station.
1666 On stations in a BSS this parameter is read-only and indicates
1667 the setting received from the access point.
1668 .It Cm cwmin Ar ac Ar count
1669 Set the CWmin channel access parameter to use for transmissions
1670 by the local station.
1671 On stations in a BSS this parameter is read-only and indicates
1672 the setting received from the access point.
1673 .It Cm cwmax Ar ac Ar count
1674 Set the CWmax channel access parameter to use for transmissions
1675 by the local station.
1676 On stations in a BSS this parameter is read-only and indicates
1677 the setting received from the access point.
1678 .It Cm txoplimit Ar ac Ar limit
1679 Set the Transmission Opportunity Limit channel access parameter
1680 to use for transmissions by the local station.
1681 This parameter defines an interval of time when a WME station
1682 has the right to initiate transmissions onto the wireless medium.
1683 On stations in a BSS this parameter is read-only and indicates
1684 the setting received from the access point.
1685 .It Cm bss:aifs Ar ac Ar count
1686 Set the AIFS channel access parameter to send to stations in a BSS.
1687 This parameter is meaningful only when operating in ap mode.
1688 .It Cm bss:cwmin Ar ac Ar count
1689 Set the CWmin channel access parameter to send to stations in a BSS.
1690 This parameter is meaningful only when operating in ap mode.
1691 .It Cm bss:cwmax Ar ac Ar count
1692 Set the CWmax channel access parameter to send to stations in a BSS.
1693 This parameter is meaningful only when operating in ap mode.
1694 .It Cm bss:txoplimit Ar ac Ar limit
1695 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1696 This parameter is meaningful only when operating in ap mode.
1699 Enable Wireless Privacy Subscriber support.
1700 Note that WPS support requires a WPS-capable supplicant.
1701 To disable this function use
1705 The following parameters support an optional access control list
1706 feature available with some adapters when operating in ap mode; see
1708 This facility allows an access point to accept/deny association
1709 requests based on the MAC address of the station.
1710 Note that this feature does not significantly enhance security
1711 as MAC address spoofing is easy to do.
1712 .Bl -tag -width indent
1713 .It Cm mac:add Ar address
1714 Add the specified MAC address to the database.
1715 Depending on the policy setting association requests from the
1716 specified station will be allowed or denied.
1718 Set the ACL policy to permit association only by
1719 stations registered in the database.
1720 .It Cm mac:del Ar address
1721 Delete the specified MAC address from the database.
1723 Set the ACL policy to deny association only by
1724 stations registered in the database.
1725 .It Cm mac:kick Ar address
1726 Force the specified station to be deauthenticated.
1727 This typically is done to block a station after updating the
1730 Set the ACL policy to allow all stations to associate.
1732 Delete all entries in the database.
1734 Set the ACL policy to permit association only by
1735 stations approved by a RADIUS server.
1736 Note that this feature requires the
1738 program be configured to do the right thing
1739 as it handles the RADIUS processing
1740 (and marks stations as authorized).
1743 The following parameters are for compatibility with other systems:
1744 .Bl -tag -width indent
1746 Another name for the
1752 .It Cm stationname Ar name
1753 Set the name of this station.
1754 The station name is not part of the IEEE 802.11
1755 protocol though some interfaces support it.
1757 seems to be meaningful to identical or virtually identical equipment.
1758 Setting the station name is identical in syntax to setting the SSID.
1765 Another way of saying
1771 Another way of saying
1777 Another way of saying:
1778 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1784 .Ar n : k1 , k2 , k3 , k4
1787 Another way of saying
1788 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1793 Another way of saying
1800 The following parameters are specific to bridge interfaces:
1801 .Bl -tag -width indent
1802 .It Cm addm Ar interface
1803 Add the interface named by
1805 as a member of the bridge.
1806 The interface is put into promiscuous mode
1807 so that it can receive every packet sent on the network.
1808 .It Cm deletem Ar interface
1809 Remove the interface named by
1812 Promiscuous mode is disabled on the interface when
1813 it is removed from the bridge.
1814 .It Cm maxaddr Ar size
1815 Set the size of the bridge address cache to
1817 The default is 100 entries.
1818 .It Cm timeout Ar seconds
1819 Set the timeout of address cache entries to
1824 is zero, then address cache entries will not be expired.
1825 The default is 240 seconds.
1827 Display the addresses that have been learned by the bridge.
1828 .It Cm static Ar interface-name Ar address
1829 Add a static entry into the address cache pointing to
1830 .Ar interface-name .
1831 Static entries are never aged out of the cache or re-placed, even if the
1832 address is seen on a different interface.
1833 .It Cm deladdr Ar address
1836 from the address cache.
1838 Delete all dynamically-learned addresses from the address cache.
1840 Delete all addresses, including static addresses, from the address cache.
1841 .It Cm discover Ar interface
1842 Mark an interface as a
1845 When the bridge has no address cache entry
1846 (either dynamic or static)
1847 for the destination address of a packet,
1848 the bridge will forward the packet to all
1849 member interfaces marked as
1851 This is the default for all interfaces added to a bridge.
1852 .It Cm -discover Ar interface
1855 attribute on a member interface.
1856 For packets without the
1858 attribute, the only packets forwarded on the interface are broadcast
1859 or multicast packets and packets for which the destination address
1860 is known to be on the interface's segment.
1861 .It Cm learn Ar interface
1862 Mark an interface as a
1865 When a packet arrives on such an interface, the source
1866 address of the packet is entered into the address cache as being a
1867 destination address on the interface's segment.
1868 This is the default for all interfaces added to a bridge.
1869 .It Cm -learn Ar interface
1872 attribute on a member interface.
1873 .It Cm sticky Ar interface
1874 Mark an interface as a
1877 Dynamically learned address entries are treated at static once entered into
1879 Sticky entries are never aged out of the cache or replaced, even if the
1880 address is seen on a different interface.
1881 .It Cm -sticky Ar interface
1884 attribute on a member interface.
1885 .It Cm private Ar interface
1886 Mark an interface as a
1889 A private interface does not forward any traffic to any other port that is also
1890 a private interface.
1891 .It Cm -private Ar interface
1894 attribute on a member interface.
1895 .It Cm span Ar interface
1896 Add the interface named by
1898 as a span port on the bridge.
1899 Span ports transmit a copy of every frame received by the bridge.
1900 This is most useful for snooping a bridged network passively on
1901 another host connected to one of the span ports of the bridge.
1902 .It Cm -span Ar interface
1903 Delete the interface named by
1905 from the list of span ports of the bridge.
1906 .It Cm stp Ar interface
1907 Enable Spanning Tree protocol on
1911 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1912 Spanning Tree is used to detect and remove loops in a network topology.
1913 .It Cm -stp Ar interface
1914 Disable Spanning Tree protocol on
1916 This is the default for all interfaces added to a bridge.
1917 .It Cm edge Ar interface
1921 An edge port connects directly to end stations cannot create bridging
1922 loops in the network, this allows it to transition straight to forwarding.
1923 .It Cm -edge Ar interface
1924 Disable edge status on
1926 .It Cm autoedge Ar interface
1929 to automatically detect edge status.
1930 This is the default for all interfaces added to a bridge.
1931 .It Cm -autoedge Ar interface
1932 Disable automatic edge status on
1934 .It Cm ptp Ar interface
1937 as a point to point link.
1938 This is required for straight transitions to forwarding and
1939 should be enabled on a direct link to another RSTP capable switch.
1940 .It Cm -ptp Ar interface
1941 Disable point to point link status on
1943 This should be disabled for a half duplex link and for an interface
1944 connected to a shared network segment,
1945 like a hub or a wireless network.
1946 .It Cm autoptp Ar interface
1947 Automatically detect the point to point status on
1949 by checking the full duplex link status.
1950 This is the default for interfaces added to the bridge.
1951 .It Cm -autoptp Ar interface
1952 Disable automatic point to point link detection on
1954 .It Cm maxage Ar seconds
1955 Set the time that a Spanning Tree protocol configuration is valid.
1956 The default is 20 seconds.
1957 The minimum is 6 seconds and the maximum is 40 seconds.
1958 .It Cm fwddelay Ar seconds
1959 Set the time that must pass before an interface begins forwarding
1960 packets when Spanning Tree is enabled.
1961 The default is 15 seconds.
1962 The minimum is 4 seconds and the maximum is 30 seconds.
1963 .It Cm hellotime Ar seconds
1964 Set the time between broadcasting of Spanning Tree protocol
1965 configuration messages.
1966 The hello time may only be changed when operating in legacy stp mode.
1967 The default is 2 seconds.
1968 The minimum is 1 second and the maximum is 2 seconds.
1969 .It Cm priority Ar value
1970 Set the bridge priority for Spanning Tree.
1971 The default is 32768.
1972 The minimum is 0 and the maximum is 61440.
1973 .It Cm proto Ar value
1974 Set the Spanning Tree protocol.
1975 The default is rstp.
1976 The available options are stp and rstp.
1977 .It Cm holdcnt Ar value
1978 Set the transmit hold count for Spanning Tree.
1979 This is the number of packets transmitted before being rate limited.
1981 The minimum is 1 and the maximum is 10.
1982 .It Cm ifpriority Ar interface Ar value
1983 Set the Spanning Tree priority of
1988 The minimum is 0 and the maximum is 240.
1989 .It Cm ifpathcost Ar interface Ar value
1990 Set the Spanning Tree path cost of
1994 The default is calculated from the link speed.
1995 To change a previously selected path cost back to automatic, set the
1997 The minimum is 1 and the maximum is 200000000.
1998 .It Cm ifmaxaddr Ar interface Ar size
1999 Set the maximum number of hosts allowed from an interface, packets with unknown
2000 source addresses are dropped until an existing host cache entry expires or is
2002 Set to 0 to disable.
2005 The following parameters are specific to lagg interfaces:
2006 .Bl -tag -width indent
2007 .It Cm laggport Ar interface
2008 Add the interface named by
2010 as a port of the aggregation interface.
2011 .It Cm -laggport Ar interface
2012 Remove the interface named by
2014 from the aggregation interface.
2015 .It Cm laggproto Ar proto
2016 Set the aggregation protocol.
2017 The default is failover.
2018 The available options are failover, fec, lacp, loadbalance, roundrobin and
2022 The following parameters are specific to IP tunnel interfaces,
2024 .Bl -tag -width indent
2025 .It Cm tunnel Ar src_addr dest_addr
2026 Configure the physical source and destination address for IP tunnel
2032 are interpreted as the outer source/destination for the encapsulating
2035 Unconfigure the physical source and destination address for IP tunnel
2036 interfaces previously configured with
2039 Another name for the
2044 The following parameters are specific to GRE tunnel interfaces,
2046 .Bl -tag -width indent
2047 .It Cm grekey Ar key
2048 Configure the GRE key to be used for outgoing packets.
2050 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2051 This command will result in a four byte MTU reduction on the interface.
2054 The following parameters are specific to
2057 .Bl -tag -width indent
2059 Set the maximum number of updates for a single state which
2060 can be collapsed into one.
2061 This is an 8-bit number; the default value is 128.
2064 The following parameters are specific to
2067 .Bl -tag -width indent
2068 .It Cm vlan Ar vlan_tag
2069 Set the VLAN tag value to
2071 This value is a 16-bit number which is used to create an 802.1Q
2072 VLAN header for packets sent from the
2079 must both be set at the same time.
2080 .It Cm vlandev Ar iface
2081 Associate the physical interface
2086 Packets transmitted through the
2089 diverted to the specified physical interface
2091 with 802.1Q VLAN encapsulation.
2092 Packets with 802.1Q encapsulation received
2093 by the parent interface with the correct VLAN tag will be diverted to
2099 interface is assigned a
2100 copy of the parent interface's flags and the parent's ethernet address.
2105 must both be set at the same time.
2108 interface already has
2109 a physical interface associated with it, this command will fail.
2111 change the association to another physical interface, the existing
2112 association must be cleared first.
2114 Note: if the hardware tagging capability
2115 is set on the parent interface, the
2118 interface's behavior changes:
2121 interface recognizes that the
2122 parent interface supports insertion and extraction of VLAN tags on its
2123 own (usually in firmware) and that it should pass packets to and from
2124 the parent unaltered.
2125 .It Fl vlandev Op Ar iface
2128 pseudo device, disassociate the parent interface from it.
2129 This breaks the link between the
2131 interface and its parent,
2132 clears its VLAN tag, flags and its link address and shuts the interface down.
2135 argument is useless and hence deprecated.
2138 The following parameters are specific to
2141 .Bl -tag -width indent
2142 .It Cm advbase Ar seconds
2143 Specifies the base of the advertisement interval in seconds.
2144 The acceptable values are 1 to 255.
2145 The default value is 1.
2146 .\" The default value is
2147 .\" .Dv CARP_DFLTINTV .
2148 .It Cm advskew Ar interval
2149 Specifies the skew to add to the base advertisement interval to
2150 make one host advertise slower than another host.
2151 It is specified in 1/256 of seconds.
2152 The acceptable values are 1 to 254.
2153 The default value is 0.
2154 .It Cm pass Ar phrase
2155 Set the authentication key to
2158 Set the virtual host ID.
2159 This is a required setting.
2160 Acceptable values are 1 to 255.
2165 utility displays the current configuration for a network interface
2166 when no optional parameters are supplied.
2167 If a protocol family is specified,
2169 will report only the details specific to that protocol family.
2173 flag is passed before an interface name,
2175 will display the capability list and all
2176 of the supported media for the specified interface.
2179 flag is supplied, address lifetime is displayed for IPv6 addresses,
2180 as time offset string.
2184 flag may be used instead of an interface name.
2187 to display information about all interfaces in the system.
2190 flag limits this to interfaces that are down, and
2192 limits this to interfaces that are up.
2193 When no arguments are given,
2199 flag may be used to list all available interfaces on the system, with
2200 no other additional information.
2201 Use of this flag is mutually exclusive
2202 with all other flags and commands, except for
2204 (only list interfaces that are down)
2207 (only list interfaces that are up).
2211 flag may be used to get more verbose status for an interface.
2215 flag may be used to list all of the interface cloners available on
2216 the system, with no additional information.
2217 Use of this flag is mutually exclusive with all other flags and commands.
2221 flag causes keying information for the interface, if available, to be
2223 For example, the values of 802.11 WEP keys will be printed, if accessible to
2225 This information is not printed by default, as it may be considered
2228 If the network interface driver is not present in the kernel then
2230 will attempt to load it.
2233 flag disables this behavior.
2235 Only the super-user may modify the configuration of a network interface.
2237 The media selection system is relatively new and only some drivers support
2238 it (or have need for it).
2240 Assign the IPv4 address
2242 with a network mask of
2246 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2248 Add the IPv4 address
2250 with the CIDR network prefix
2256 as a synonym for the canonical form of the option
2258 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2260 Remove the IPv4 address
2264 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2266 Add the IPv6 address
2267 .Li 2001:DB8:DBDB::123/48
2270 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2271 Note that lower case hexadecimal IPv6 addresses are acceptable.
2273 Remove the IPv6 address added in the above example,
2276 character as shorthand for the network prefix,
2279 as a synonym for the canonical form of the option
2281 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2283 Configure the interface
2285 to use 100baseTX, full duplex Ethernet media options:
2286 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2288 Create the software network interface
2290 .Dl # ifconfig gif1 create
2292 Destroy the software network interface
2294 .Dl # ifconfig gif1 destroy
2296 Messages indicating the specified interface does not exist, the
2297 requested address is unknown, or the user is not privileged and
2298 tried to alter an interface's configuration.
2316 Basic IPv6 node operation requires a link-local address on each
2317 interface configured for IPv6.
2318 Normally, such an address is automatically configured by the
2319 kernel on each interface added to the system; this behaviour may
2320 be disabled by setting the sysctl MIB variable
2321 .Va net.inet6.ip6.auto_linklocal
2324 If you delete such an address using
2326 the kernel may act very odd.
2327 Do this at your own risk.
projects / FreeBSD / FreeBSD.git / blob