1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
80 utility is used to assign an address
81 to a network interface and/or configure
82 network interface parameters.
85 utility must be used at boot time to define the network address
86 of each interface present on a machine; it may also be used at
87 a later time to redefine an interface's address
88 or other operating parameters.
90 The following options are available:
91 .Bl -tag -width indent
94 .Tn DARPA Ns -Internet
96 the address is either a host name present in the host name data
101 Internet address expressed in the Internet standard
104 It is also possible to use the CIDR notation (also known as the
105 slash notation) to include the netmask.
106 That is, one can specify an address like
111 family, it is also possible to specify the prefix length using the slash
116 parameter below for more information.
117 .\" For the Xerox Network Systems(tm) family,
119 .\" .Ar net:a.b.c.d.e.f ,
122 .\" is the assigned network number (in decimal),
123 .\" and each of the six bytes of the host number,
127 .\" are specified in hexadecimal.
128 .\" The host number may be omitted on IEEE 802 protocol
129 .\" (Ethernet, FDDI, and Token Ring) interfaces,
130 .\" which use the hardware physical address,
131 .\" and on interfaces other than the first.
134 .\" family, addresses are specified as a long hexadecimal string,
135 .\" as in the Xerox family.
136 .\" However, two consecutive dots imply a zero
137 .\" byte, and the dots are optional, if the user wishes to (carefully)
138 .\" count out long strings of digits in network byte order.
143 is specified as a series of colon-separated hex digits.
144 This can be used to, for example,
145 set a new MAC address on an Ethernet interface, though the
146 mechanism used is not Ethernet specific.
147 If the interface is already
148 up when this option is used, it will be briefly brought down and
149 then brought back up again in order to ensure that the receive
150 filter in the underlying Ethernet hardware is properly reprogrammed.
151 .It Ar address_family
154 which affects interpretation of the remaining parameters.
155 Since an interface can receive transmissions in differing protocols
156 with different naming schemes, specifying the address family is recommended.
157 The address or protocol families currently
168 The default if available is
181 address family has special meaning and is no longer synonymous with
187 will list only Ethernet interfaces, excluding all other interface types,
188 including the loopback interface.
190 Specify the address of the correspondent on the other end
191 of a point to point link.
194 parameter is a string of the form
199 List the interfaces in the given group.
202 The following parameters may be set with
204 .Bl -tag -width indent
209 Introduced for compatibility
213 Establish an additional network address for this interface.
214 This is sometimes useful when changing network numbers, and
215 one wishes to accept packets addressed to the old interface.
216 If the address is on the same subnet as the first network address
217 for this interface, a non-conflicting netmask must be given.
222 Remove the network address specified.
223 This would be used if you incorrectly specified an alias, or it
224 was no longer needed.
225 If you have incorrectly set an NS address having the side effect
226 of specifying the host portion, removing all NS addresses will
227 allow you to respecify the host portion.
230 Specify that the address configured is an anycast address.
231 Based on the current specification,
232 only routers may configure anycast addresses.
233 Anycast address will not be used as source address of any of outgoing
236 Enable the use of the Address Resolution Protocol
239 between network level addresses and link level addresses (default).
240 This is currently implemented for mapping between
245 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
247 Disable the use of the Address Resolution Protocol
250 If the Address Resolution Protocol is enabled,
251 the host will only reply to requests for its addresses,
252 and will never send any requests.
254 If the Address Resolution Protocol is enabled,
255 the host will perform normally,
256 sending out requests and listening for replies.
259 Specify the address to use to represent broadcasts to the
261 The default broadcast address is the address with a host part of all 1's.
263 Enable driver dependent debugging code; usually, this turns on
264 extra console error logging.
266 Disable driver dependent debugging code.
268 Put interface into permanently promiscuous mode.
270 Disable permanently promiscuous mode.
275 .It Cm description Ar value , Cm descr Ar value
276 Specify a description of the interface.
277 This can be used to label interfaces in situations where they may
278 otherwise be difficult to distinguish.
279 .It Cm -description , Cm -descr
280 Clear the interface description.
284 When an interface is marked
286 the system will not attempt to
287 transmit messages through that interface.
288 If possible, the interface will be reset to disable reception as well.
289 This action does not automatically disable routes using the interface.
290 .It Cm group Ar group-name
291 Assign the interface to a
293 Any interface can be in multiple groups.
295 Cloned interfaces are members of their interface family group by default.
296 For example, a PPP interface such as
298 is a member of the PPP interface family group,
300 .\" The interface(s) the default route(s) point to are members of the
303 .It Cm -group Ar group-name
304 Remove the interface from the given
309 (lowermost 64bit of an IPv6 address)
311 .It Cm fib Ar fib_number
312 Specify interface FIB.
315 is assigned to all frames or packets received on that interface.
316 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
317 the default FIB (0) irrespective of the parent interface's FIB.
318 The kernel needs to be tuned to support more than the default FIB
321 kernel configuration option, or the
324 .It Cm tunnelfib Ar fib_number
328 is assigned to all packets encapsulated by tunnel interface, e.g.,
333 This is used to specify an Internet host who is willing to receive
334 IP packets encapsulating IPX packets bound for a remote network.
335 An apparent point to point link is constructed, and
336 the address specified will be taken as the IPX address and network
338 .It Cm maclabel Ar label
339 If Mandatory Access Control support is enabled in the kernel,
343 .\" .Xr maclabel 7 ) .
345 If the driver supports the media selection system, set the media type
348 Some interfaces support the mutually exclusive use of one of several
349 different physical media connectors.
350 For example, a 10Mbit/s Ethernet
351 interface might support the use of either
353 or twisted pair connectors.
354 Setting the media type to
356 would change the currently active connector to the AUI port.
359 would activate twisted pair.
360 Refer to the interfaces' driver
361 specific documentation or man page for a complete list of the
363 .It Cm mediaopt Ar opts
364 If the driver supports the media selection system, set the specified
365 media options on the interface.
369 is a comma delimited list of options to apply to the interface.
370 Refer to the interfaces' driver specific man page for a complete
371 list of available options.
372 .It Fl mediaopt Ar opts
373 If the driver supports the media selection system, disable the
374 specified media options on the interface.
376 If the driver supports the media selection system, set the specified
377 operating mode on the interface to
379 For IEEE 802.11 wireless interfaces that support multiple operating modes
380 this directive is used to select between 802.11a
387 .It Cm inst Ar minst , Cm instance Ar minst
388 Set the media instance to
390 This is useful for devices which have multiple physical layer interfaces
393 Set the interface name to
395 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
396 If the driver supports user-configurable checksum offloading,
397 enable receive (or transmit) checksum offloading on the interface.
398 The feature can be turned on selectively per protocol family.
400 .Cm rxcsum6 , txcsum6
406 Some drivers may not be able to enable these flags independently
407 of each other, so setting one may also set the other.
408 The driver will offload as much checksum work as it can reliably
409 support, the exact level of offloading varies between drivers.
410 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
411 If the driver supports user-configurable checksum offloading,
412 disable receive (or transmit) checksum offloading on the interface.
413 The feature can be turned off selectively per protocol family.
415 .Fl rxcsum6 , txcsum6
421 These settings may not always be independent of each other.
423 If the driver supports
425 segmentation offloading, enable TSO on the interface.
426 Some drivers may not be able to support TSO for
430 packets, so they may enable only one of them.
432 If the driver supports
434 segmentation offloading, disable TSO on the interface.
435 It will always disable TSO for
440 If the driver supports
442 segmentation offloading for
446 use one of these to selectively enabled it only for one protocol family.
448 If the driver supports
450 segmentation offloading for
454 use one of these to selectively disable it only for one protocol family.
456 If the driver supports
458 large receive offloading, enable LRO on the interface.
460 If the driver supports
462 large receive offloading, disable LRO on the interface.
463 .It Cm wol , wol_ucast , wol_mcast , wol_magic
464 Enable Wake On Lan (WOL) support, if available.
465 WOL is a facility whereby a machine in a low power state may be woken
466 in response to a received packet.
467 There are three types of packets that may wake a system:
468 ucast (directed solely to the machine's mac address),
469 mcast (directed to a broadcast or multicast address),
471 magic (unicast or multicast frames with a ``magic contents'').
472 Not all devices support WOL, those that do indicate the mechanisms
473 they support in their capabilities.
475 is a synonym for enabling all available WOL mechanisms.
478 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
479 If the driver offers user-configurable VLAN support, enable
480 reception of extended frames, tag processing in hardware,
481 frame filtering in hardware, checksum offloading, or TSO on VLAN,
483 Note that this must be issued on a physical interface associated with
488 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
489 If the driver offers user-configurable VLAN support, disable
490 reception of extended frames, tag processing in hardware,
491 frame filtering in hardware, or TSO on VLAN,
494 Move the interface to the
496 specified by name or JID.
497 If the jail has a virtual network stack, the interface will disappear
498 from the current environment and become visible to the jail.
500 Reclaim the interface from the
502 specified by name or JID.
503 If the jail has a virtual network stack, the interface will disappear
504 from the jail, and become visible to the current network environment.
508 feature and disable interrupts on the interface, if driver supports
513 feature and enable interrupt mode on the interface.
515 Create the specified network pseudo-device.
516 If the interface is given without a unit number, try to create a new
517 device with an arbitrary unit number.
518 If creation of an arbitrary device is successful, the new device name is
519 printed to standard output unless the interface is renamed or destroyed
524 Destroy the specified network pseudo-device.
540 Set the routing metric of the interface to
543 The routing metric is used by the routing protocol
545 Higher metrics have the effect of making a route
546 less favorable; metrics are counted as additional hops
547 to the destination network or host.
549 Set the maximum transmission unit of the interface to
551 default is interface specific.
552 The MTU is used to limit the size of packets that are transmitted on an
554 Not all interfaces support setting the MTU, and some interfaces have
556 .It Cm netmask Ar mask
559 Specify how much of the address to reserve for subdividing
560 networks into sub-networks.
561 The mask includes the network part of the local address
562 and the subnet part, which is taken from the host field of the address.
563 The mask can be specified as a single hexadecimal number
566 with a dot-notation Internet address,
567 or with a pseudo-network name listed in the network table
569 The mask contains 1's for the bit positions in the 32-bit address
570 which are to be used for the network and subnet parts,
571 and 0's for the host part.
572 The mask should contain at least the standard network portion,
573 and the subnet field should be contiguous with the network
576 The netmask can also be specified in CIDR notation after the address.
579 option above for more information.
580 .It Cm prefixlen Ar len
584 bits are reserved for subdividing networks into sub-networks.
587 must be integer, and for syntactical reason it must be between 0 to 128.
588 It is almost always 64 under the current IPv6 assignment rule.
589 If the parameter is omitted, 64 is used.
591 The prefix can also be specified using the slash notation after the address.
594 option above for more information.
597 .\" .It Cm nsellength Ar n
600 .\" This specifies a trailing number of bytes for a received
602 .\" used for local identification, the remaining leading part of which is
605 .\" (Network Entity Title).
606 .\" The default value is 1, which is conformant to US
608 .\" When an ISO address is set in an ifconfig command,
611 .\" which is being specified.
614 .\" 20 hex digits should be
617 .\" to be assigned to the interface.
618 .\" There is some evidence that a number different from 1 may be useful
621 .\" 37 type addresses.
622 .It Cm range Ar netrange
623 Under appletalk, set the interface to respond to a
626 .Ar startnet Ns - Ns Ar endnet .
627 Appletalk uses this scheme instead of
630 implements it internally as a set of netmasks.
635 Introduced for compatibility
639 The argument following this specifies the version (phase) of the
640 Appletalk network attached to the interface.
641 Values of 1 or 2 are permitted.
643 .It Cm link Op Cm 0 No - Cm 2
645 Enable special processing of the link level of the interface.
646 These three options are interface specific in actual effect, however,
647 they are in general used to select special modes of operation.
649 of this is to enable SLIP compression, or to select the connector type
650 for some Ethernet cards.
651 Refer to the man page for the specific driver
652 for more information.
654 .It Fl link Op Cm 0 No - Cm 2
656 Disable special processing at the link level with the specified interface.
658 Put the interface in monitor mode.
659 No packets are transmitted, and received packets are discarded after
663 Take the interface out of monitor mode.
667 This may be used to enable an interface after an
669 It happens automatically when setting the first address on an interface.
670 If the interface was reset when previously marked down,
671 the hardware will be re-initialized.
674 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
675 Note that the address family keyword
678 .Bl -tag -width indent
680 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
684 .Va net.inet6.ip6.accept_rtadv
685 controls whether this flag is set by default or not.
690 Set a flag to control whether routers from which the system accepts
691 Router Advertisement messages will be added to the Default Router List
695 flag is disabled, this flag has no effect.
699 .Va net.inet6.ip6.no_radr
700 controls whether this flag is set by default or not.
704 .It Cm auto_linklocal
705 Set a flag to perform automatic link-local address configuration when
706 the interface becomes available.
710 .Va net.inet6.ip6.auto_linklocal
711 controls whether this flag is set by default or not.
712 .It Cm -auto_linklocal
716 Set the specified interface as the default route when there is no
722 Set a flag to disable all of IPv6 network communications on the
724 Note that if there are already configured IPv6
725 addresses on that interface, all of them are marked as
727 and DAD will be performed when this flag is cleared.
731 When this flag is cleared and
733 flag is enabled, automatic configuration of a link-local address is
736 Set a flag to enable Neighbor Unreachability Detection.
740 .It Cm no_prefer_iface
741 Set a flag to not prefer address on the interface as candidates of the
742 source address for outgoing packets, even when the interface is
744 .It Cm -no_prefer_iface
746 .Cm no_prefer_iface .
748 Set a flag to disable Duplicate Address Detection.
754 The following parameters are specific for IPv6 addresses.
755 Note that the address family keyword
758 .Bl -tag -width indent
760 Set a flag to prefer address as a candidate of the source address for
762 .It Cm -prefer_source
767 The following parameters are specific to cloning
768 IEEE 802.11 wireless interfaces with the
771 .Bl -tag -width indent
772 .It Cm wlandev Ar device
775 as the parent for the cloned device.
776 .It Cm wlanmode Ar mode
777 Specify the operating mode for this cloned device.
795 The operating mode of a cloned interface cannot be changed.
798 mode is actually implemented as an
800 interface with special properties.
801 .It Cm wlanbssid Ar bssid
802 The 802.11 mac address to use for the bssid.
803 This must be specified at create time for a legacy
806 .It Cm wlanaddr Ar address
807 The local mac address.
808 If this is not specified then a mac address will automatically be assigned
809 to the cloned device.
810 Typically this address is the same as the address of the parent device
813 parameter is specified then the driver will craft a unique address for
814 the device (if supported).
818 device as operating in ``legacy mode''.
821 devices have a fixed peer relationship and do not, for example, roam
822 if their peer stops communicating.
823 For completeness a Dynamic WDS (DWDS) interface may marked as
826 Request a unique local mac address for the cloned device.
827 This is only possible if the device supports multiple mac addresses.
828 To force use of the parent's mac address use
831 Mark the cloned interface as depending on hardware support to
832 track received beacons.
833 To have beacons tracked in software use
839 can also be used to indicate no beacons should
840 be transmitted; this can be useful when creating a WDS configuration but
842 interfaces can only be created as companions to an access point.
845 The following parameters are specific to IEEE 802.11 wireless interfaces
849 .Bl -tag -width indent
851 Enable sending and receiving AMPDU frames when using 802.11n (default).
852 The 802.11n specification states a compliant station must be capable
853 of receiving AMPDU frames but transmission is optional.
856 to disable all use of AMPDU with 802.11n.
857 For testing and/or to work around interoperability problems one can use
861 to control use of AMPDU in one direction.
862 .It Cm ampdudensity Ar density
863 Set the AMPDU density parameter used when operating with 802.11n.
864 This parameter controls the inter-packet gap for AMPDU frames.
865 The sending device normally controls this setting but a receiving station
866 may request wider gaps.
869 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
872 is treated the same as 0.
873 .It Cm ampdulimit Ar limit
874 Set the limit on packet size for receiving AMPDU frames when operating
878 are 8192, 16384, 32768, and 65536 but one can also specify
879 just the unique prefix: 8, 16, 32, 64.
880 Note the sender may limit the size of AMPDU frames to be less
881 than the maximum specified by the receiving station.
883 Enable sending and receiving AMSDU frames when using 802.11n.
884 By default AMSDU is received but not transmitted.
887 to disable all use of AMSDU with 802.11n.
888 For testing and/or to work around interoperability problems one can use
892 to control use of AMSDU in one direction.
893 .It Cm amsdulimit Ar limit
894 Set the limit on packet size for sending and receiving AMSDU frames
895 when operating with 802.11n.
898 are 7935 and 3839 (bytes).
899 Note the sender may limit the size of AMSDU frames to be less
900 than the maximum specified by the receiving station.
901 Note also that devices are not required to support the 7935 limit,
902 only 3839 is required by the specification and the larger value
903 may require more memory to be dedicated to support functionality
906 When operating as an access point, pass packets between
907 wireless clients directly (default).
908 To instead let them pass up through the
909 system and be forwarded using some other mechanism, use
911 Disabling the internal bridging
912 is useful when traffic is to be processed with
914 .It Cm authmode Ar mode
915 Set the desired authentication mode in infrastructure mode.
916 Not all adapters support all modes.
919 .Cm none , open , shared
925 (IEEE WPA/WPA2/802.11i).
930 modes are only useful when using an authentication service
931 (a supplicant for client operation or an authenticator when
932 operating as an access point).
933 Modes are case insensitive.
935 Enable background scanning when operating as a station.
936 Background scanning is a technique whereby a station associated to
937 an access point will temporarily leave the channel to scan for
938 neighboring stations.
939 This allows a station to maintain a cache of nearby access points
940 so that roaming between access points can be done without
941 a lengthy scan operation.
942 Background scanning is done only when a station is not busy and
943 any outbound traffic will cancel a scan operation.
944 Background scanning should never cause packets to be lost though
945 there may be some small latency if outbound traffic interrupts a
947 By default background scanning is enabled if the device is capable.
948 To disable background scanning, use
950 Background scanning is controlled by the
955 Background scanning must be enabled for roaming; this is an artifact
956 of the current implementation and may not be required in the future.
957 .It Cm bgscanidle Ar idletime
958 Set the minimum time a station must be idle (not transmitting or
959 receiving frames) before a background scan is initiated.
962 parameter is specified in milliseconds.
963 By default a station must be idle at least 250 milliseconds before
964 a background scan is initiated.
965 The idle time may not be set to less than 100 milliseconds.
966 .It Cm bgscanintvl Ar interval
967 Set the interval at which background scanning is attempted.
970 parameter is specified in seconds.
971 By default a background scan is considered every 300 seconds (5 minutes).
974 may not be set to less than 15 seconds.
975 .It Cm bintval Ar interval
976 Set the interval at which beacon frames are sent when operating in
980 parameter is specified in TU's (1024 usecs).
981 By default beacon frames are transmitted every 100 TU's.
982 .It Cm bmissthreshold Ar count
983 Set the number of consecutive missed beacons at which the station
984 will attempt to roam (i.e., search for a new access point).
987 parameter must be in the range 1 to 255; though the
988 upper bound may be reduced according to device capabilities.
989 The default threshold is 7 consecutive missed beacons; but
990 this may be overridden by the device driver.
995 .It Cm bssid Ar address
996 Specify the MAC address of the access point to use when operating
997 as a station in a BSS network.
998 This overrides any automatic selection done by the system.
999 To disable a previously selected access point, supply
1004 This option is useful when more than one access point uses the same SSID.
1005 Another name for the
1010 Enable packet bursting.
1011 Packet bursting is a transmission technique whereby the wireless
1012 medium is acquired once to send multiple frames and the interframe
1014 This technique can significantly increase throughput by reducing
1015 transmission overhead.
1016 Packet bursting is supported by the 802.11e QoS specification
1017 and some devices that do not support QoS may still be capable.
1018 By default packet bursting is enabled if a device is capable
1020 To disable packet bursting, use
1022 .It Cm chanlist Ar channels
1023 Set the desired channels to use when scanning for access
1024 points, neighbors in an IBSS network, or looking for unoccupied
1025 channels when operating as an access point.
1026 The set of channels is specified as a comma-separated list with
1027 each element in the list representing either a single channel number or a range
1030 Channel numbers must be in the range 1 to 255 and be permissible
1031 according to the operating characteristics of the device.
1032 .It Cm channel Ar number
1033 Set a single desired channel.
1034 Channels range from 1 to 255, but the exact selection available
1035 depends on the region your adaptor was manufactured for.
1041 will clear any desired channel and, if the device is marked up,
1042 force a scan for a channel to operate on.
1043 Alternatively the frequency, in megahertz, may be specified
1044 instead of the channel number.
1046 When there are several ways to use a channel the channel
1047 number/frequency may be appended with attributes to clarify.
1048 For example, if a device is capable of operating on channel 6
1049 with 802.11n and 802.11g then one can specify that g-only use
1050 should be used by specifying ``6:g''.
1051 Similarly the channel width can be specified by appending it
1052 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1053 These attributes can be combined as in: ``6:ht/40''.
1054 The full set of flags specified following a ``:'' are:
1060 (Atheros Dynamic Turbo mode),
1068 (Atheros Static Turbo mode),
1071 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1072 The full set of channel widths following a '/' are:
1074 (5MHz aka quarter-rate channel),
1076 (10MHz aka half-rate channel),
1078 (20MHz mostly for use in specifying ht20),
1081 (40MHz mostly for use in specifying ht40).
1083 a 40MHz HT channel specification may include the location
1084 of the extension channel by appending ``+'' or ``-'' for above and below,
1085 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1086 with the center channel at frequency 2437 and the extension channel above.
1087 .It Cm country Ar name
1088 Set the country code to use in calculating the regulatory constraints
1090 In particular the set of available channels, how the wireless device
1091 will operation on the channels, and the maximum transmit power that
1092 can be used on a channel are defined by this setting.
1093 Country/Region codes are specified as a 2-character abbreviation
1094 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1095 e.g., "ES" and "Spain".
1096 The set of country codes are taken from
1097 .Pa /etc/regdomain.xml
1099 be viewed with the ``list countries'' request.
1100 Note that not all devices support changing the country code from a default
1101 setting; typically stored in EEPROM.
1109 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1110 DFS embodies several facilities including detection of overlapping
1111 radar signals, dynamic transmit power control, and channel selection
1112 according to a least-congested criteria.
1113 DFS support is mandatory for some 5GHz frequencies in certain
1114 locales (e.g., ETSI).
1115 By default DFS is enabled according to the regulatory definitions
1117 .Pa /etc/regdomain.xml
1118 and the current country code, regdomain,
1120 Note the underlying device (and driver) must support radar detection
1121 for full DFS support to work.
1122 To be fully compliant with the local regulatory agency frequencies that
1123 require DFS should not be used unless it is fully supported.
1126 to disable this functionality for testing.
1128 Enable support for the 802.11d specification (default).
1129 When this support is enabled in station mode, beacon frames that advertise
1130 a country code different than the currently configured country code will
1131 cause an event to be dispatched to user applications.
1132 This event can be used by the station to adopt that country code and
1133 operate according to the associated regulatory constraints.
1134 When operating as an access point with 802.11d enabled the beacon and
1135 probe response frames transmitted will advertise the current regulatory
1137 To disable 802.11d use
1140 Enable 802.11h support including spectrum management.
1141 When 802.11h is enabled beacon and probe response frames will have
1142 the SpectrumMgt bit set in the capabilities field and
1143 country and power constraint information elements will be present.
1144 802.11h support also includes handling Channel Switch Announcements (CSA)
1145 which are a mechanism to coordinate channel changes by an access point.
1146 By default 802.11h is enabled if the device is capable.
1147 To disable 802.11h use
1149 .It Cm deftxkey Ar index
1150 Set the default key to use for transmission.
1151 Typically this is only set when using WEP encryption.
1152 Note that you must set a default transmit key
1153 for the system to know which key to use in encrypting outbound traffic.
1156 is an alias for this request; it is provided for backwards compatibility.
1157 .It Cm dtimperiod Ar period
1160 period for transmitting buffered multicast data frames when
1161 operating in ap mode.
1164 specifies the number of beacon intervals between DTIM
1165 and must be in the range 1 to 15.
1166 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1168 Enable the use of quiet IE.
1169 Hostap will use this to silence other
1170 stations to reduce interference for radar detection when
1171 operating on 5GHz frequency and doth support is enabled.
1174 to disable this functionality.
1175 .It Cm quiet_period Ar period
1178 to the number of beacon intervals between the start of regularly
1179 scheduled quiet intervals defined by Quiet element.
1180 .It Cm quiet_count Ar count
1183 to the number of TBTTs until the beacon interval during which the
1184 next quiet interval shall start.
1185 A value of 1 indicates the quiet
1186 interval will start during the beacon interval starting at the next
1188 A value 0 is reserved.
1189 .It Cm quiet_offset Ar offset
1192 to the offset of the start of the quiet interval from the TBTT
1193 specified by the Quiet count, expressed in TUs.
1196 shall be less than one beacon interval.
1197 .It Cm quiet_duration Ar dur
1200 to the duration of the Quiet interval, expressed in TUs.
1201 The value should be less than beacon interval.
1203 Enable the use of Atheros Dynamic Turbo mode when communicating with
1204 another Dynamic Turbo-capable station.
1205 Dynamic Turbo mode is an Atheros-specific mechanism by which
1206 stations switch between normal 802.11 operation and a ``boosted''
1207 mode in which a 40MHz wide channel is used for communication.
1208 Stations using Dynamic Turbo mode operate boosted only when the
1209 channel is free of non-dturbo stations; when a non-dturbo station
1210 is identified on the channel all stations will automatically drop
1211 back to normal operation.
1212 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1213 Note that turbo mode (dynamic or static) is only allowed on some
1214 channels depending on the regulatory constraints; use the
1216 command to identify the channels where turbo mode may be used.
1217 To disable Dynamic Turbo mode use
1220 Enable Dynamic WDS (DWDS) support.
1221 DWDS is a facility by which 4-address traffic can be carried between
1222 stations operating in infrastructure mode.
1223 A station first associates to an access point and authenticates using
1224 normal procedures (e.g., WPA).
1225 Then 4-address frames are passed to carry traffic for stations
1226 operating on either side of the wireless link.
1227 DWDS extends the normal WDS mechanism by leveraging existing security
1228 protocols and eliminating static binding.
1230 When DWDS is enabled on an access point 4-address frames received from
1231 an authorized station will generate a ``DWDS discovery'' event to user
1233 This event should be used to create a WDS interface that is bound
1234 to the remote station (and usually plumbed into a bridge).
1235 Once the WDS interface is up and running 4-address traffic then logically
1236 flows through that interface.
1238 When DWDS is enabled on a station, traffic with a destination address
1239 different from the peer station are encapsulated in a 4-address frame
1240 and transmitted to the peer.
1241 All 4-address traffic uses the security information of the stations
1242 (e.g., cryptographic keys).
1243 A station is associated using 802.11n facilities may transport
1244 4-address traffic using these same mechanisms; this depends on available
1245 resources and capabilities of the device.
1246 The DWDS implementation guards against layer 2 routing loops of
1249 Enable the use of Atheros Fast Frames when communicating with
1250 another Fast Frames-capable station.
1251 Fast Frames are an encapsulation technique by which two 802.3
1252 frames are transmitted in a single 802.11 frame.
1253 This can noticeably improve throughput but requires that the
1254 receiving station understand how to decapsulate the frame.
1255 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1256 protocol extension so enabling use is safe when communicating with
1257 non-Atheros devices.
1258 By default, use of fast frames is enabled if the device is capable.
1259 To explicitly disable fast frames, use
1261 .It Cm fragthreshold Ar length
1262 Set the threshold for which transmitted frames are broken into fragments.
1265 argument is the frame size in bytes and must be in the range 256 to 2346.
1273 disables transmit fragmentation.
1274 Not all adapters honor the fragmentation threshold.
1276 When operating as an access point, do not broadcast the SSID
1277 in beacon frames or respond to probe request frames unless
1278 they are directed to the ap (i.e., they include the ap's SSID).
1279 By default, the SSID is included in beacon frames and
1280 undirected probe request frames are answered.
1281 To re-enable the broadcast of the SSID etc., use
1284 Enable use of High Throughput (HT) when using 802.11n (default).
1285 The 802.11n specification includes mechanisms for operation
1286 on 20MHz and 40MHz wide channels using different signalling mechanisms
1287 than specified in 802.11b, 802.11g, and 802.11a.
1288 Stations negotiate use of these facilities, termed HT20 and HT40,
1289 when they associate.
1290 To disable all use of 802.11n use
1292 To disable use of HT20 (e.g., to force only HT40 use) use
1294 To disable use of HT40 use
1297 HT configuration is used to ``auto promote'' operation
1298 when several choices are available.
1299 For example, if a station associates to an 11n-capable access point
1300 it controls whether the station uses legacy operation, HT20, or HT40.
1301 When an 11n-capable device is setup as an access point and
1302 Auto Channel Selection is used to locate a channel to operate on,
1303 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1304 on the selected channel.
1305 If a fixed channel is specified for a station then HT configuration can
1306 be given as part of the channel specification; e.g., 6:ht/20 to setup
1307 HT20 operation on channel 6.
1309 Enable use of compatibility support for pre-802.11n devices (default).
1310 The 802.11n protocol specification went through several incompatible iterations.
1311 Some vendors implemented 11n support to older specifications that
1312 will not interoperate with a purely 11n-compliant station.
1313 In particular the information elements included in management frames
1314 for old devices are different.
1315 When compatibility support is enabled both standard and compatible data
1317 Stations that associate using the compatibility mechanisms are flagged
1319 To disable compatibility support use
1321 .It Cm htprotmode Ar technique
1322 For interfaces operating in 802.11n, use the specified
1324 for protecting HT frames in a mixed legacy/HT network.
1325 The set of valid techniques is
1330 Technique names are case insensitive.
1332 Enable inactivity processing for stations associated to an
1333 access point (default).
1334 When operating as an access point the 802.11 layer monitors
1335 the activity of each associated station.
1336 When a station is inactive for 5 minutes it will send several
1337 ``probe frames'' to see if the station is still present.
1338 If no response is received then the station is deauthenticated.
1339 Applications that prefer to handle this work can disable this
1343 Set the location to use in calculating regulatory constraints.
1344 The location is also advertised in beacon and probe response frames
1345 when 802.11d is enabled with
1354 Display the list of channels available for use taking into account
1355 any restrictions set with the
1358 See the description of
1360 for more information.
1362 Display the adaptor's capabilities, including the operating
1365 Display the list of channels available for use.
1366 Channels are shown with their IEEE channel number, equivalent
1367 frequency, and usage modes.
1368 Channels identified as
1373 Channels identified as
1375 may be used only for Atheros' Static Turbo mode
1377 . Cm mediaopt turbo ) .
1378 Channels marked with a
1380 have a regulatory constraint that they be passively scanned.
1381 This means a station is not permitted to transmit on the channel until
1382 it identifies the channel is being used for 802.11 communication;
1383 typically by hearing a beacon frame from an access point operating
1386 is another way of requesting this information.
1387 By default a compacted list of channels is displayed; if the
1389 option is specified then all channels are shown.
1390 .It Cm list countries
1391 Display the set of country codes and regulatory domains that can be
1392 used in regulatory configuration.
1394 Display the current MAC Access Control List state.
1395 Each address is prefixed with a character that indicates the
1396 current policy applied to it:
1398 indicates the address is allowed access,
1400 indicates the address is denied access,
1402 indicates the address is present but the current policy open
1403 (so the ACL is not consulted).
1405 Displays the mesh routing table, used for forwarding packets on a mesh
1407 .It Cm list regdomain
1408 Display the current regulatory settings including the available channels
1409 and transmit power caps.
1411 Display the parameters that govern roaming operation.
1413 Display the parameters that govern transmit operation.
1415 Display the transmit power caps for each channel.
1417 Display the access points and/or ad-hoc neighbors
1418 located in the vicinity.
1419 This information may be updated automatically by the adapter
1422 request or through background scanning.
1423 Depending on the capabilities of the stations the following
1424 flags can be included in the output:
1428 Indicates that the station is permitted to send/receive data frames.
1430 Extended Rate Phy (ERP).
1431 Indicates that the station is operating in an 802.11g network
1432 using extended transmit rates.
1434 High Throughput (HT).
1435 Indicates that the station is using HT transmit rates.
1436 If a `+' follows immediately after then the station associated
1437 using deprecated mechanisms supported only when
1442 Indicates that the station is operating in power save mode.
1444 Quality of Service (QoS).
1445 Indicates that the station is using QoS encapsulation for
1447 QoS encapsulation is enabled only when WME mode is enabled.
1450 Indicates that the station is doing short preamble to optionally
1451 improve throughput performance with 802.11g and 802.11b.
1453 Transitional Security Network (TSN).
1454 Indicates that the station associated using TSN; see also
1458 Wi-Fi Protected Setup (WPS).
1459 Indicates that the station associated using WPS.
1462 By default interesting information elements captured from the neighboring
1463 stations are displayed at the end of each row.
1464 Possible elements include:
1466 (station supports WME),
1468 (station supports WPA),
1470 (station supports WPS),
1472 (station supports 802.11i/RSN),
1474 (station supports 802.11n/HT communication),
1476 (station supports Atheros protocol extensions),
1478 (station supports unknown vendor-specific extensions).
1481 flag is used all the information elements and their
1482 contents will be shown.
1485 flag also enables display of long SSIDs.
1488 command is another way of requesting this information.
1490 When operating as an access point display the stations that are
1491 currently associated.
1492 When operating in ad-hoc mode display stations identified as
1493 neighbors in the IBSS.
1494 When operating in mesh mode display stations identified as
1495 neighbors in the MBSS.
1496 When operating in station mode display the access point.
1497 Capabilities advertised by the stations are described under
1501 Depending on the capabilities of the stations the following
1502 flags can be included in the output:
1506 Indicates that the station is permitted to send/receive data frames.
1508 Extended Rate Phy (ERP).
1509 Indicates that the station is operating in an 802.11g network
1510 using extended transmit rates.
1512 High Throughput (HT).
1513 Indicates that the station is using HT transmit rates.
1514 If a `+' follows immediately after then the station associated
1515 using deprecated mechanisms supported only when
1520 Indicates that the station is operating in power save mode.
1522 Quality of Service (QoS).
1523 Indicates that the station is using QoS encapsulation for
1525 QoS encapsulation is enabled only when WME mode is enabled.
1528 Indicates that the station is doing short preamble to optionally
1529 improve throughput performance with 802.11g and 802.11b.
1531 Transitional Security Network (TSN).
1532 Indicates that the station associated using TSN; see also
1536 Wi-Fi Protected Setup (WPS).
1537 Indicates that the station associated using WPS.
1540 By default information elements received from associated stations
1541 are displayed in a short form; the
1543 flag causes this information to be displayed symbolically.
1545 Display the current channel parameters to use when operating in WME mode.
1548 option is specified then both channel and BSS parameters are displayed
1549 for each AC (first channel, then BSS).
1550 When WME mode is enabled for an adaptor this information will be
1551 displayed with the regular status; this command is mostly useful
1552 for examining parameters when WME mode is disabled.
1553 See the description of the
1555 directive for information on the various parameters.
1556 .It Cm maxretry Ar count
1557 Set the maximum number of tries to use in sending unicast frames.
1558 The default setting is 6 but drivers may override this with a value
1560 .It Cm mcastrate Ar rate
1561 Set the rate for transmitting multicast/broadcast frames.
1562 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1563 This rate should be valid for the current operating conditions;
1564 if an invalid rate is specified drivers are free to chose an
1566 .It Cm mgtrate Ar rate
1567 Set the rate for transmitting management and/or control frames.
1568 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1570 Set the location to use in calculating regulatory constraints.
1571 The location is also advertised in beacon and probe response frames
1572 when 802.11d is enabled with
1581 Enable powersave operation.
1582 When operating as a client, the station will conserve power by
1583 periodically turning off the radio and listening for
1584 messages from the access point telling it there are packets waiting.
1585 The station must then retrieve the packets.
1586 Not all devices support power save operation as a client.
1587 The 802.11 specification requires that all access points support
1588 power save but some drivers do not.
1591 to disable powersave operation when operating as a client.
1592 .It Cm powersavesleep Ar sleep
1593 Set the desired max powersave sleep time in TU's (1024 usecs).
1594 By default the max powersave sleep time is 100 TU's.
1595 .It Cm protmode Ar technique
1596 For interfaces operating in 802.11g, use the specified
1598 for protecting OFDM frames in a mixed 11b/11g network.
1599 The set of valid techniques is
1605 Technique names are case insensitive.
1606 Not all devices support
1608 as a protection technique.
1610 When operating as an access point in 802.11g mode allow only
1611 11g-capable stations to associate (11b-only stations are not
1612 permitted to associate).
1613 To allow both 11g and 11b-only stations to associate, use
1616 When operating as an access point in 802.11n mode allow only
1617 HT-capable stations to associate (legacy stations are not
1618 permitted to associate).
1619 To allow both HT and legacy stations to associate, use
1621 .It Cm regdomain Ar sku
1622 Set the regulatory domain to use in calculating the regulatory constraints
1624 In particular the set of available channels, how the wireless device
1625 will operation on the channels, and the maximum transmit power that
1626 can be used on a channel are defined by this setting.
1627 Regdomain codes (SKU's) are taken from
1628 .Pa /etc/regdomain.xml
1630 be viewed with the ``list countries'' request.
1631 Note that not all devices support changing the regdomain from a default
1632 setting; typically stored in EEPROM.
1640 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1642 Note that RIFS must be supported by both the station and access point
1646 .It Cm roam:rate Ar rate
1647 Set the threshold for controlling roaming when operating in a BSS.
1650 parameter specifies the transmit rate in megabits
1651 at which roaming should be considered.
1652 If the current transmit rate drops below this setting and background scanning
1653 is enabled, then the system will check if a more desirable access point is
1654 available and switch over to it.
1655 The current scan cache contents are used if they are considered
1656 valid according to the
1658 parameter; otherwise a background scan operation is triggered before
1659 any selection occurs.
1660 Each channel type has a separate rate threshold; the default values are:
1661 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1662 .It Cm roam:rssi Ar rssi
1663 Set the threshold for controlling roaming when operating in a BSS.
1666 parameter specifies the receive signal strength in dBm units
1667 at which roaming should be considered.
1668 If the current rssi drops below this setting and background scanning
1669 is enabled, then the system will check if a more desirable access point is
1670 available and switch over to it.
1671 The current scan cache contents are used if they are considered
1672 valid according to the
1674 parameter; otherwise a background scan operation is triggered before
1675 any selection occurs.
1676 Each channel type has a separate rssi threshold; the default values are
1678 .It Cm roaming Ar mode
1679 When operating as a station, control how the system will
1680 behave when communication with the current access point
1684 argument may be one of
1686 (leave it to the hardware device to decide),
1688 (handle either in the device or the operating system\[em]as appropriate),
1690 (do nothing until explicitly instructed).
1691 By default, the device is left to handle this if it is
1692 capable; otherwise, the operating system will automatically
1693 attempt to reestablish communication.
1694 Manual mode is used by applications such as
1695 .Xr wpa_supplicant 8
1696 that want to control the selection of an access point.
1697 .It Cm rtsthreshold Ar length
1698 Set the threshold for which
1699 transmitted frames are preceded by transmission of an
1705 is the frame size in bytes and must be in the range 1 to 2346.
1713 disables transmission of RTS frames.
1714 Not all adapters support setting the RTS threshold.
1716 Initiate a scan of neighboring stations, wait for it to complete, and
1717 display all stations found.
1718 Only the super-user can initiate a scan.
1721 for information on the display.
1722 By default a background scan is done; otherwise a foreground
1723 scan is done and the station may roam to a different access point.
1726 request can be used to show recent scan results without
1727 initiating a new scan.
1728 .It Cm scanvalid Ar threshold
1729 Set the maximum time the scan cache contents are considered valid;
1730 i.e., will be used without first triggering a scan operation to
1734 parameter is specified in seconds and defaults to 60 seconds.
1735 The minimum setting for
1738 One should take care setting this threshold; if it is set too low
1739 then attempts to roam to another access point may trigger unnecessary
1740 background scan operations.
1742 Enable use of Short Guard Interval when operating in 802.11n
1744 NB: this currently enables Short GI on both HT40 and HT20 channels.
1745 To disable Short GI use
1748 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1749 when operating in 802.11n.
1750 A station operating with Static SMPS maintains only a single
1751 receive chain active (this can significantly reduce power consumption).
1755 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1756 when operating in 802.11n.
1757 A station operating with Dynamic SMPS maintains only a single
1758 receive chain active but switches to multiple receive chains when it
1759 receives an RTS frame (this can significantly reduce power consumption).
1760 Note that stations cannot distinguish between RTS/CTS intended to
1761 enable multiple receive chains and those used for other purposes.
1765 Set the desired Service Set Identifier (aka network name).
1766 The SSID is a string up to 32 characters
1767 in length and may be specified as either a normal string or in
1768 hexadecimal when preceded by
1770 Additionally, the SSID may be cleared by setting it to
1772 .It Cm tdmaslot Ar slot
1773 When operating with TDMA, use the specified
1778 is a number between 0 and the maximum number of slots in the BSS.
1779 Note that a station configured as slot 0 is a master and
1780 will broadcast beacon frames advertising the BSS;
1781 stations configured to use other slots will always
1782 scan to locate a master before they ever transmit.
1786 .It Cm tdmaslotcnt Ar cnt
1787 When operating with TDMA, setup a BSS with
1790 The slot count may be at most 8.
1791 The current implementation is only tested with two stations
1792 (i.e., point to point applications).
1793 This setting is only meaningful when a station is configured as slot 0;
1794 other stations adopt this setting from the BSS they join.
1798 .It Cm tdmaslotlen Ar len
1799 When operating with TDMA, setup a BSS such that each station has a slot
1802 The slot length must be at least 150 microseconds (1/8 TU)
1803 and no more than 65 milliseconds.
1804 Note that setting too small a slot length may result in poor channel
1805 bandwidth utilization due to factors such as timer granularity and
1807 This setting is only meaningful when a station is configured as slot 0;
1808 other stations adopt this setting from the BSS they join.
1811 is set to 10 milliseconds.
1812 .It Cm tdmabintval Ar intval
1813 When operating with TDMA, setup a BSS such that beacons are transmitted every
1815 superframes to synchronize the TDMA slot timing.
1816 A superframe is defined as the number of slots times the slot length; e.g.,
1817 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1818 The beacon interval may not be zero.
1821 causes the timers to be resynchronized more often; this can be help if
1822 significant timer drift is observed.
1827 When operating as an access point with WPA/802.11i allow legacy
1828 stations to associate using static key WEP and open authentication.
1829 To disallow legacy station use of WEP, use
1831 .It Cm txpower Ar power
1832 Set the power used to transmit frames.
1835 argument is specified in .5 dBm units.
1836 Out of range values are truncated.
1837 Typically only a few discreet power settings are available and
1838 the driver will use the setting closest to the specified value.
1839 Not all adapters support changing the transmit power.
1840 .It Cm ucastrate Ar rate
1841 Set a fixed rate for transmitting unicast frames.
1842 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1843 This rate should be valid for the current operating conditions;
1844 if an invalid rate is specified drivers are free to chose an
1846 .It Cm wepmode Ar mode
1847 Set the desired WEP mode.
1848 Not all adapters support all modes.
1849 The set of valid modes is
1855 mode explicitly tells the adaptor to allow association with access
1856 points which allow both encrypted and unencrypted traffic.
1859 means that the access point must only allow encrypted connections.
1862 is generally another name for
1864 Modes are case insensitive.
1865 .It Cm weptxkey Ar index
1866 Set the WEP key to be used for transmission.
1867 This is the same as setting the default transmission key with
1869 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1870 Set the selected WEP key.
1873 is not given, key 1 is set.
1874 A WEP key will be either 5 or 13
1875 characters (40 or 104 bits) depending on the local network and the
1876 capabilities of the adaptor.
1877 It may be specified either as a plain
1878 string or as a string of hexadecimal digits preceded by
1880 For maximum portability, hex keys are recommended;
1881 the mapping of text keys to WEP encryption is usually driver-specific.
1884 drivers do this mapping differently to
1886 A key may be cleared by setting it to
1888 If WEP is supported then there are at least four keys.
1889 Some adapters support more than four keys.
1890 If that is the case, then the first four keys
1891 (1-4) will be the standard temporary keys and any others will be adaptor
1892 specific keys such as permanent keys stored in NVRAM.
1894 Note that you must set a default transmit key with
1896 for the system to know which key to use in encrypting outbound traffic.
1898 Enable Wireless Multimedia Extensions (WME) support, if available,
1899 for the specified interface.
1900 WME is a subset of the IEEE 802.11e standard to support the
1901 efficient communication of realtime and multimedia data.
1902 To disable WME support, use
1904 Another name for this parameter is
1907 The following parameters are meaningful only when WME support is in use.
1908 Parameters are specified per-AC (Access Category) and
1909 split into those that are used by a station when acting
1910 as an access point and those for client stations in the BSS.
1911 The latter are received from the access point and may not be changed
1913 The following Access Categories are recognized:
1915 .Bl -tag -width ".Cm AC_BK" -compact
1919 best effort delivery,
1934 AC parameters are case-insensitive.
1935 Traffic classification is done in the operating system using the
1936 vlan priority associated with data frames or the
1937 ToS (Type of Service) indication in IP-encapsulated frames.
1938 If neither information is present, traffic is assigned to the
1939 Best Effort (BE) category.
1940 .Bl -tag -width indent
1942 Set the ACK policy for QoS transmissions by the local station;
1943 this controls whether or not data frames transmitted by a station
1944 require an ACK response from the receiving station.
1945 To disable waiting for an ACK use
1947 This parameter is applied only to the local station.
1949 Enable the Admission Control Mandatory (ACM) mechanism
1950 for transmissions by the local station.
1951 To disable the ACM use
1953 On stations in a BSS this parameter is read-only and indicates
1954 the setting received from the access point.
1955 NB: ACM is not supported right now.
1956 .It Cm aifs Ar ac Ar count
1957 Set the Arbitration Inter Frame Spacing (AIFS)
1958 channel access parameter to use for transmissions
1959 by the local station.
1960 On stations in a BSS this parameter is read-only and indicates
1961 the setting received from the access point.
1962 .It Cm cwmin Ar ac Ar count
1963 Set the CWmin channel access parameter to use for transmissions
1964 by the local station.
1965 On stations in a BSS this parameter is read-only and indicates
1966 the setting received from the access point.
1967 .It Cm cwmax Ar ac Ar count
1968 Set the CWmax channel access parameter to use for transmissions
1969 by the local station.
1970 On stations in a BSS this parameter is read-only and indicates
1971 the setting received from the access point.
1972 .It Cm txoplimit Ar ac Ar limit
1973 Set the Transmission Opportunity Limit channel access parameter
1974 to use for transmissions by the local station.
1975 This parameter defines an interval of time when a WME station
1976 has the right to initiate transmissions onto the wireless medium.
1977 On stations in a BSS this parameter is read-only and indicates
1978 the setting received from the access point.
1979 .It Cm bss:aifs Ar ac Ar count
1980 Set the AIFS channel access parameter to send to stations in a BSS.
1981 This parameter is meaningful only when operating in ap mode.
1982 .It Cm bss:cwmin Ar ac Ar count
1983 Set the CWmin channel access parameter to send to stations in a BSS.
1984 This parameter is meaningful only when operating in ap mode.
1985 .It Cm bss:cwmax Ar ac Ar count
1986 Set the CWmax channel access parameter to send to stations in a BSS.
1987 This parameter is meaningful only when operating in ap mode.
1988 .It Cm bss:txoplimit Ar ac Ar limit
1989 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1990 This parameter is meaningful only when operating in ap mode.
1993 Enable Wireless Privacy Subscriber support.
1994 Note that WPS support requires a WPS-capable supplicant.
1995 To disable this function use
1999 The following parameters support an optional access control list
2000 feature available with some adapters when operating in ap mode; see
2002 This facility allows an access point to accept/deny association
2003 requests based on the MAC address of the station.
2004 Note that this feature does not significantly enhance security
2005 as MAC address spoofing is easy to do.
2006 .Bl -tag -width indent
2007 .It Cm mac:add Ar address
2008 Add the specified MAC address to the database.
2009 Depending on the policy setting association requests from the
2010 specified station will be allowed or denied.
2012 Set the ACL policy to permit association only by
2013 stations registered in the database.
2014 .It Cm mac:del Ar address
2015 Delete the specified MAC address from the database.
2017 Set the ACL policy to deny association only by
2018 stations registered in the database.
2019 .It Cm mac:kick Ar address
2020 Force the specified station to be deauthenticated.
2021 This typically is done to block a station after updating the
2024 Set the ACL policy to allow all stations to associate.
2026 Delete all entries in the database.
2028 Set the ACL policy to permit association only by
2029 stations approved by a RADIUS server.
2030 Note that this feature requires the
2032 program be configured to do the right thing
2033 as it handles the RADIUS processing
2034 (and marks stations as authorized).
2037 The following parameters are related to a wireless interface operating in mesh
2039 .Bl -tag -width indent
2040 .It Cm meshid Ar meshid
2041 Set the desired Mesh Identifier.
2042 The Mesh ID is a string up to 32 characters in length.
2043 A mesh interface must have a Mesh Identifier specified
2044 to reach an operational state.
2045 .It Cm meshttl Ar ttl
2046 Set the desired ``time to live'' for mesh forwarded packets;
2047 this is the number of hops a packet may be forwarded before
2049 The default setting for
2053 Enable or disable peering with neighbor mesh stations.
2054 Stations must peer before any data packets can be exchanged.
2059 Enable or disable forwarding packets by a mesh interface.
2064 This attribute specifies whether or not the mesh STA activates mesh gate
2069 .It Cm meshmetric Ar protocol
2072 as the link metric protocol used on a mesh network.
2073 The default protocol is called
2075 The mesh interface will restart after changing this setting.
2076 .It Cm meshpath Ar protocol
2079 as the path selection protocol used on a mesh network.
2080 The only available protocol at the moment is called
2082 (Hybrid Wireless Mesh Protocol).
2083 The mesh interface will restart after changing this setting.
2084 .It Cm hwmprootmode Ar mode
2085 Stations on a mesh network can operate as ``root nodes.''
2086 Root nodes try to find paths to all mesh nodes and advertise themselves
2088 When there is a root mesh node on a network, other mesh nodes can setup
2089 paths between themselves faster because they can use the root node
2090 to find the destination.
2091 This path may not be the best, but on-demand
2092 routing will eventually find the best path.
2093 The following modes are recognized:
2095 .Bl -tag -width ".Cm PROACTIVE" -compact
2099 Send broadcast path requests every two seconds.
2100 Nodes on the mesh without a path to this root mesh station with try to
2101 discover a path to us.
2103 Send broadcast path requests every two seconds and every node must reply
2104 with a path reply even if it already has a path to this root mesh station.
2106 Send broadcast root announcement (RANN) frames.
2107 Nodes on the mesh without a path to this root mesh station with try to
2108 discover a path to us.
2114 .It Cm hwmpmaxhops Ar cnt
2115 Set the maximum number of hops allowed in an HMWP path to
2117 The default setting for
2122 The following parameters are for compatibility with other systems:
2123 .Bl -tag -width indent
2125 Another name for the
2131 .It Cm stationname Ar name
2132 Set the name of this station.
2133 The station name is not part of the IEEE 802.11
2134 protocol though some interfaces support it.
2136 seems to be meaningful to identical or virtually identical equipment.
2137 Setting the station name is identical in syntax to setting the SSID.
2144 Another way of saying
2150 Another way of saying
2156 Another way of saying:
2157 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2163 .Ar n : k1 , k2 , k3 , k4
2166 Another way of saying
2167 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2172 Another way of saying
2179 The following parameters are specific to bridge interfaces:
2180 .Bl -tag -width indent
2181 .It Cm addm Ar interface
2182 Add the interface named by
2184 as a member of the bridge.
2185 The interface is put into promiscuous mode
2186 so that it can receive every packet sent on the network.
2187 .It Cm deletem Ar interface
2188 Remove the interface named by
2191 Promiscuous mode is disabled on the interface when
2192 it is removed from the bridge.
2193 .It Cm maxaddr Ar size
2194 Set the size of the bridge address cache to
2196 The default is 2000 entries.
2197 .It Cm timeout Ar seconds
2198 Set the timeout of address cache entries to
2203 is zero, then address cache entries will not be expired.
2204 The default is 1200 seconds.
2206 Display the addresses that have been learned by the bridge.
2207 .It Cm static Ar interface-name Ar address
2208 Add a static entry into the address cache pointing to
2209 .Ar interface-name .
2210 Static entries are never aged out of the cache or re-placed, even if the
2211 address is seen on a different interface.
2212 .It Cm deladdr Ar address
2215 from the address cache.
2217 Delete all dynamically-learned addresses from the address cache.
2219 Delete all addresses, including static addresses, from the address cache.
2220 .It Cm discover Ar interface
2221 Mark an interface as a
2224 When the bridge has no address cache entry
2225 (either dynamic or static)
2226 for the destination address of a packet,
2227 the bridge will forward the packet to all
2228 member interfaces marked as
2230 This is the default for all interfaces added to a bridge.
2231 .It Cm -discover Ar interface
2234 attribute on a member interface.
2235 For packets without the
2237 attribute, the only packets forwarded on the interface are broadcast
2238 or multicast packets and packets for which the destination address
2239 is known to be on the interface's segment.
2240 .It Cm learn Ar interface
2241 Mark an interface as a
2244 When a packet arrives on such an interface, the source
2245 address of the packet is entered into the address cache as being a
2246 destination address on the interface's segment.
2247 This is the default for all interfaces added to a bridge.
2248 .It Cm -learn Ar interface
2251 attribute on a member interface.
2252 .It Cm sticky Ar interface
2253 Mark an interface as a
2256 Dynamically learned address entries are treated at static once entered into
2258 Sticky entries are never aged out of the cache or replaced, even if the
2259 address is seen on a different interface.
2260 .It Cm -sticky Ar interface
2263 attribute on a member interface.
2264 .It Cm private Ar interface
2265 Mark an interface as a
2268 A private interface does not forward any traffic to any other port that is also
2269 a private interface.
2270 .It Cm -private Ar interface
2273 attribute on a member interface.
2274 .It Cm span Ar interface
2275 Add the interface named by
2277 as a span port on the bridge.
2278 Span ports transmit a copy of every frame received by the bridge.
2279 This is most useful for snooping a bridged network passively on
2280 another host connected to one of the span ports of the bridge.
2281 .It Cm -span Ar interface
2282 Delete the interface named by
2284 from the list of span ports of the bridge.
2285 .It Cm stp Ar interface
2286 Enable Spanning Tree protocol on
2290 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2291 Spanning Tree is used to detect and remove loops in a network topology.
2292 .It Cm -stp Ar interface
2293 Disable Spanning Tree protocol on
2295 This is the default for all interfaces added to a bridge.
2296 .It Cm edge Ar interface
2300 An edge port connects directly to end stations cannot create bridging
2301 loops in the network, this allows it to transition straight to forwarding.
2302 .It Cm -edge Ar interface
2303 Disable edge status on
2305 .It Cm autoedge Ar interface
2308 to automatically detect edge status.
2309 This is the default for all interfaces added to a bridge.
2310 .It Cm -autoedge Ar interface
2311 Disable automatic edge status on
2313 .It Cm ptp Ar interface
2316 as a point to point link.
2317 This is required for straight transitions to forwarding and
2318 should be enabled on a direct link to another RSTP capable switch.
2319 .It Cm -ptp Ar interface
2320 Disable point to point link status on
2322 This should be disabled for a half duplex link and for an interface
2323 connected to a shared network segment,
2324 like a hub or a wireless network.
2325 .It Cm autoptp Ar interface
2326 Automatically detect the point to point status on
2328 by checking the full duplex link status.
2329 This is the default for interfaces added to the bridge.
2330 .It Cm -autoptp Ar interface
2331 Disable automatic point to point link detection on
2333 .It Cm maxage Ar seconds
2334 Set the time that a Spanning Tree protocol configuration is valid.
2335 The default is 20 seconds.
2336 The minimum is 6 seconds and the maximum is 40 seconds.
2337 .It Cm fwddelay Ar seconds
2338 Set the time that must pass before an interface begins forwarding
2339 packets when Spanning Tree is enabled.
2340 The default is 15 seconds.
2341 The minimum is 4 seconds and the maximum is 30 seconds.
2342 .It Cm hellotime Ar seconds
2343 Set the time between broadcasting of Spanning Tree protocol
2344 configuration messages.
2345 The hello time may only be changed when operating in legacy stp mode.
2346 The default is 2 seconds.
2347 The minimum is 1 second and the maximum is 2 seconds.
2348 .It Cm priority Ar value
2349 Set the bridge priority for Spanning Tree.
2350 The default is 32768.
2351 The minimum is 0 and the maximum is 61440.
2352 .It Cm proto Ar value
2353 Set the Spanning Tree protocol.
2354 The default is rstp.
2355 The available options are stp and rstp.
2356 .It Cm holdcnt Ar value
2357 Set the transmit hold count for Spanning Tree.
2358 This is the number of packets transmitted before being rate limited.
2360 The minimum is 1 and the maximum is 10.
2361 .It Cm ifpriority Ar interface Ar value
2362 Set the Spanning Tree priority of
2367 The minimum is 0 and the maximum is 240.
2368 .It Cm ifpathcost Ar interface Ar value
2369 Set the Spanning Tree path cost of
2373 The default is calculated from the link speed.
2374 To change a previously selected path cost back to automatic, set the
2376 The minimum is 1 and the maximum is 200000000.
2377 .It Cm ifmaxaddr Ar interface Ar size
2378 Set the maximum number of hosts allowed from an interface, packets with unknown
2379 source addresses are dropped until an existing host cache entry expires or is
2381 Set to 0 to disable.
2384 The following parameters are specific to lagg interfaces:
2385 .Bl -tag -width indent
2386 .It Cm laggport Ar interface
2387 Add the interface named by
2389 as a port of the aggregation interface.
2390 .It Cm -laggport Ar interface
2391 Remove the interface named by
2393 from the aggregation interface.
2394 .It Cm laggproto Ar proto
2395 Set the aggregation protocol.
2398 The available options are
2406 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2407 Set the packet layers to hash for aggregation protocols which load balance.
2410 The options can be combined using commas.
2412 .Bl -tag -width ".Cm l2" -compact
2414 src/dst mac address and optional vlan number.
2416 src/dst address for IPv4 or IPv6.
2418 src/dst port for TCP/UDP/SCTP.
2421 Enable local hash computation for RSS hash on the interface.
2426 modes will use the RSS hash from the network card if available
2427 to avoid computing one, this may give poor traffic distribution
2428 if the hash is invalid or uses less of the protocol header information.
2430 disables use of RSS hash from the network card.
2431 The default value can be set via the
2432 .Va net.link.lagg.default_use_flowid
2443 Use the RSS hash from the network card if available.
2444 .It Cm flowid_shift Ar number
2445 Set a shift parameter for RSS local hash computation.
2446 Hash is calculated by using flowid bits in a packet header mbuf
2447 which are shifted by the number of this parameter.
2448 .It Cm lacp_fast_timeout
2449 Enable lacp fast-timeout on the interface.
2450 .It Cm -lacp_fast_timeout
2451 Disable lacp fast-timeout on the interface.
2453 Enable lacp strict compliance on the interface.
2454 The default value can be set via the
2455 .Va net.link.lagg.lacp.default_strict_mode
2466 Disable lacp strict compliance on the interface.
2469 The following parameters are specific to IP tunnel interfaces,
2471 .Bl -tag -width indent
2472 .It Cm tunnel Ar src_addr dest_addr
2473 Configure the physical source and destination address for IP tunnel
2479 are interpreted as the outer source/destination for the encapsulating
2482 Unconfigure the physical source and destination address for IP tunnel
2483 interfaces previously configured with
2486 Another name for the
2489 .It Cm accept_rev_ethip_ver
2490 Set a flag to accept both correct EtherIP packets and ones
2491 with reversed version field.
2493 This is for backward compatibility with
2495 6.2, 6.3, 7.0, and 7.1.
2496 .It Cm -accept_rev_ethip_ver
2498 .Cm accept_rev_ethip_ver .
2499 .It Cm ignore_source
2500 Set a flag to accept encapsulated packets destined to this host
2501 independently from source address.
2502 This may be useful for hosts, that receive encapsulated packets
2503 from the load balancers.
2504 .It Cm -ignore_source
2507 .It Cm send_rev_ethip_ver
2508 Set a flag to send EtherIP packets with reversed version
2509 field intentionally.
2510 Disabled by default.
2511 This is for backward compatibility with
2513 6.2, 6.3, 7.0, and 7.1.
2514 .It Cm -send_rev_ethip_ver
2516 .Cm send_rev_ethip_ver .
2519 The following parameters are specific to GRE tunnel interfaces,
2521 .Bl -tag -width indent
2522 .It Cm grekey Ar key
2523 Configure the GRE key to be used for outgoing packets.
2525 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2526 This command will result in a four byte MTU reduction on the interface.
2529 The following parameters are specific to
2532 .Bl -tag -width indent
2533 .It Cm syncdev Ar iface
2534 Use the specified interface
2535 to send and receive pfsync state synchronisation messages.
2537 Stop sending pfsync state synchronisation messages over the network.
2538 .It Cm syncpeer Ar peer_address
2539 Make the pfsync link point-to-point rather than using
2540 multicast to broadcast the state synchronisation messages.
2541 The peer_address is the IP address of the other host taking part in
2544 Broadcast the packets using multicast.
2546 Set the maximum number of updates for a single state which
2547 can be collapsed into one.
2548 This is an 8-bit number; the default value is 128.
2550 Defer transmission of the first packet in a state until a peer has
2551 acknowledged that the associated state has been inserted.
2553 Do not defer the first packet in a state.
2554 This is the default.
2557 The following parameters are specific to
2560 .Bl -tag -width indent
2561 .It Cm vlan Ar vlan_tag
2562 Set the VLAN tag value to
2564 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2565 VLAN header for packets sent from the
2572 must both be set at the same time.
2573 .It Cm vlandev Ar iface
2574 Associate the physical interface
2579 Packets transmitted through the
2582 diverted to the specified physical interface
2584 with 802.1Q VLAN encapsulation.
2585 Packets with 802.1Q encapsulation received
2586 by the parent interface with the correct VLAN Identifier will be diverted to
2592 interface is assigned a
2593 copy of the parent interface's flags and the parent's Ethernet address.
2598 must both be set at the same time.
2601 interface already has
2602 a physical interface associated with it, this command will fail.
2604 change the association to another physical interface, the existing
2605 association must be cleared first.
2607 Note: if the hardware tagging capability
2608 is set on the parent interface, the
2611 interface's behavior changes:
2614 interface recognizes that the
2615 parent interface supports insertion and extraction of VLAN tags on its
2616 own (usually in firmware) and that it should pass packets to and from
2617 the parent unaltered.
2618 .It Fl vlandev Op Ar iface
2621 pseudo device, disassociate the parent interface from it.
2622 This breaks the link between the
2624 interface and its parent,
2625 clears its VLAN Identifier, flags and its link address and shuts the interface
2629 argument is useless and hence deprecated.
2632 The following parameters are used to configure
2635 .Bl -tag -width indent
2636 .It Cm vxlanid Ar identifier
2637 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2638 virtual network segment membership of the interface.
2639 .It Cm vxlanlocal Ar address
2640 The source address used in the encapsulating IPv4/IPv6 header.
2641 The address should already be assigned to an existing interface.
2642 When the interface is configured in unicast mode, the listening socket
2643 is bound to this address.
2644 .It Cm vxlanremote Ar address
2645 The interface can be configured in a unicast, or point-to-point, mode
2646 to create a tunnel between two hosts.
2647 This is the IP address of the remote end of the tunnel.
2648 .It Cm vxlangroup Ar address
2649 The interface can be configured in a multicast mode
2650 to create a virtual network of hosts.
2651 This is the IP multicast group address the interface will join.
2652 .It Cm vxlanlocalport Ar port
2653 The port number the interface will listen on.
2654 The default port number is 4789.
2655 .It Cm vxlanremoteport Ar port
2656 The destination port number used in the encapsulating IPv4/IPv6 header.
2657 The remote host should be listening on this port.
2658 The default port number is 4789.
2659 Note some other implementations, such as Linux,
2660 do not default to the IANA assigned port,
2661 but instead listen on port 8472.
2662 .It Cm vxlanportrange Ar low high
2663 The range of source ports used in the encapsulating IPv4/IPv6 header.
2664 The port selected within the range is based on a hash of the inner frame.
2665 A range is useful to provide entropy within the outer IP header
2666 for more effective load balancing.
2667 The default range is between the
2670 .Va net.inet.ip.portrange.first
2672 .Va net.inet.ip.portrange.last
2673 .It Cm vxlantimeout Ar timeout
2674 The maximum time, in seconds, before an entry in the forwarding table
2676 The default is 1200 seconds (20 minutes).
2677 .It Cm vxlanmaxaddr Ar max
2678 The maximum number of entries in the forwarding table.
2679 The default is 2000.
2680 .It Cm vxlandev Ar dev
2681 When the interface is configured in multicast mode, the
2683 interface is used to transmit IP multicast packets.
2684 .It Cm vxlanttl Ar ttl
2685 The TTL used in the encapsulating IPv4/IPv6 header.
2688 The source IP address and inner source Ethernet MAC address of
2689 received packets are used to dynamically populate the forwarding table.
2690 When in multicast mode, an entry in the forwarding table allows the
2691 interface to send the frame directly to the remote host instead of
2692 broadcasting the frame to the multicast group.
2693 This is the default.
2695 The forwarding table is not populated by recevied packets.
2697 Delete all dynamically-learned addresses from the forwarding table.
2698 .It Cm vxlanflushall
2699 Delete all addresses, including static addresses, from the forwarding table.
2702 The following parameters are used to configure
2704 protocol on an interface:
2705 .Bl -tag -width indent
2707 Set the virtual host ID.
2708 This is a required setting to initiate
2710 If the virtual host ID does not exist yet, it is created and attached to the
2711 interface, otherwise configuration of an existing vhid is adjusted.
2714 keyword is supplied along with an
2718 address, then this address is configured to be run under control of the
2720 Whenever a last address that refers to a particular vhid is removed from an
2721 interface, the vhid is automatically removed from interface and destroyed.
2722 Any other configuration parameters for the
2724 protocol should be supplied along with the
2727 Acceptable values for vhid are 1 to 255.
2728 .It Cm advbase Ar seconds
2729 Specifies the base of the advertisement interval in seconds.
2730 The acceptable values are 1 to 255.
2731 The default value is 1.
2732 .It Cm advskew Ar interval
2733 Specifies the skew to add to the base advertisement interval to
2734 make one host advertise slower than another host.
2735 It is specified in 1/256 of seconds.
2736 The acceptable values are 1 to 254.
2737 The default value is 0.
2738 .It Cm pass Ar phrase
2739 Set the authentication key to
2741 .It Cm state Ar MASTER|BACKUP
2742 Forcibly change state of a given vhid.
2747 utility displays the current configuration for a network interface
2748 when no optional parameters are supplied.
2749 If a protocol family is specified,
2751 will report only the details specific to that protocol family.
2755 flag is passed before an interface name,
2757 will display the capability list and all
2758 of the supported media for the specified interface.
2761 flag is supplied, address lifetime is displayed for IPv6 addresses,
2762 as time offset string.
2766 flag may be used instead of an interface name.
2769 to display information about all interfaces in the system.
2772 flag limits this to interfaces that are down, and
2774 limits this to interfaces that are up.
2775 When no arguments are given,
2781 flag may be used to list all available interfaces on the system, with
2782 no other additional information.
2785 is specified, only interfaces of that type will be listed.
2787 will list only Ethernet adapters, excluding the loopback interface.
2788 Use of this flag is mutually exclusive
2789 with all other flags and commands, except for
2791 (only list interfaces that are down)
2794 (only list interfaces that are up).
2798 flag may be used to get more verbose status for an interface.
2802 flag may be used to list all of the interface cloners available on
2803 the system, with no additional information.
2804 Use of this flag is mutually exclusive with all other flags and commands.
2808 flag causes keying information for the interface, if available, to be
2810 For example, the values of 802.11 WEP keys and
2812 passphrases will be printed, if accessible to the current user.
2813 This information is not printed by default, as it may be considered
2816 If the network interface driver is not present in the kernel then
2818 will attempt to load it.
2821 flag disables this behavior.
2823 Only the super-user may modify the configuration of a network interface.
2825 Assign the IPv4 address
2827 with a network mask of
2831 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2833 Add the IPv4 address
2835 with the CIDR network prefix
2841 as a synonym for the canonical form of the option
2843 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2845 Remove the IPv4 address
2849 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2851 Enable IPv6 functionality of the interface:
2852 .Dl # ifconfig em0 inet6 -ifdisabled
2854 Add the IPv6 address
2855 .Li 2001:DB8:DBDB::123/48
2858 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2859 Note that lower case hexadecimal IPv6 addresses are acceptable.
2861 Remove the IPv6 address added in the above example,
2864 character as shorthand for the network prefix,
2867 as a synonym for the canonical form of the option
2869 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2871 Configure a single CARP redundant address on igb0, and then switch it
2873 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2874 .Dl # ifconfig igb0 vhid 1 state master
2876 Configure the interface
2878 to use 100baseTX, full duplex Ethernet media options:
2879 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2881 Label the em0 interface as an uplink:
2882 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2884 Create the software network interface
2886 .Dl # ifconfig gif1 create
2888 Destroy the software network interface
2890 .Dl # ifconfig gif1 destroy
2892 Display available wireless networks using
2894 .Dl # ifconfig wlan0 list scan
2896 Messages indicating the specified interface does not exist, the
2897 requested address is unknown, or the user is not privileged and
2898 tried to alter an interface's configuration.
2921 Basic IPv6 node operation requires a link-local address on each
2922 interface configured for IPv6.
2923 Normally, such an address is automatically configured by the
2924 kernel on each interface added to the system or enabled; this behavior may
2925 be disabled by setting per-interface flag
2926 .Cm -auto_linklocal .
2927 The default value of this flag is 1 and can be disabled by using the sysctl
2929 .Va net.inet6.ip6.auto_linklocal .
2931 Do not configure IPv6 addresses with no link-local address by using
2933 It can result in unexpected behaviors of the kernel.