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
31 .Dd September 17, 2016
36 .Nd configure network interface parameters
39 .Op Fl f Ar type:format Ns Op Ar ,type:format
81 utility is used to assign an address
82 to a network interface and/or configure
83 network interface parameters.
86 utility must be used at boot time to define the network address
87 of each interface present on a machine; it may also be used at
88 a later time to redefine an interface's address
89 or other operating parameters.
91 The following options are available:
92 .Bl -tag -width indent
95 .Tn DARPA Ns -Internet
97 the address is either a host name present in the host name data
102 Internet address expressed in the Internet standard
105 It is also possible to use the CIDR notation (also known as the
106 slash notation) to include the netmask.
107 That is, one can specify an address like
112 family, it is also possible to specify the prefix length using the slash
117 parameter below for more information.
118 .\" For the Xerox Network Systems(tm) family,
120 .\" .Ar net:a.b.c.d.e.f ,
123 .\" is the assigned network number (in decimal),
124 .\" and each of the six bytes of the host number,
128 .\" are specified in hexadecimal.
129 .\" The host number may be omitted on IEEE 802 protocol
130 .\" (Ethernet, FDDI, and Token Ring) interfaces,
131 .\" which use the hardware physical address,
132 .\" and on interfaces other than the first.
135 .\" family, addresses are specified as a long hexadecimal string,
136 .\" as in the Xerox family.
137 .\" However, two consecutive dots imply a zero
138 .\" byte, and the dots are optional, if the user wishes to (carefully)
139 .\" count out long strings of digits in network byte order.
144 is specified as a series of colon-separated hex digits.
145 This can be used to, for example,
146 set a new MAC address on an Ethernet interface, though the
147 mechanism used is not Ethernet specific.
150 keyword to set a randomly generated MAC address.
151 A randomly-generated MAC address might be the same as one already in use
153 Such duplications are extremely unlikely.
154 If the interface is already
155 up when this option is used, it will be briefly brought down and
156 then brought back up again in order to ensure that the receive
157 filter in the underlying Ethernet hardware is properly reprogrammed.
158 .It Ar address_family
161 which affects interpretation of the remaining parameters.
162 Since an interface can receive transmissions in differing protocols
163 with different naming schemes, specifying the address family is recommended.
164 The address or protocol families currently
170 The default if available is
183 address family has special meaning and is no longer synonymous with
189 will list only Ethernet interfaces, excluding all other interface types,
190 including the loopback interface.
192 Specify the address of the correspondent on the other end
193 of a point to point link.
196 parameter is a string of the form
201 List the interfaces in the given group.
206 can be controlled using the
210 environment variable.
211 The format is specified as a comma separated list of
216 section for more information.
222 .Bl -tag -width ether
224 Adjust the display of inet and inet6 addresses
225 .Bl -tag -width default
227 Display inet and inet6 addresses in the default format,
230 Display inet and inet6 addresses as fully qualified domain names
233 Display inet and inet6 addresses as unqualified hostnames
235 Display inet and inet6 addresses in numeric format
238 Adjust the display of link-level ethernet (MAC) addresses
239 .Bl -tag -width default
241 Separate address segments with a colon
243 Separate address segments with a dash
245 Display ethernet addresses in the default format,
249 Adjust the display of inet address subnet masks:
250 .Bl -tag -width default
252 Display subnet masks in CIDR notation, for example:
254 10.0.0.0/8 or 203.0.113.224/26
256 Display subnet masks in the default format,
259 Display subnet masks in dotted quad notation, for example:
261 255.255.0.0 or 255.255.255.192
263 Display subnet masks in hexadecimal, for example:
265 0xffff0000 or 0xffffffc0
268 Adjust the display of inet6 address prefixes (subnet masks):
269 .Bl -tag -width default
271 Display subnet prefix in CIDR notation, for example:
273 ::1/128 or fe80::1%lo0/64
275 Display subnet prefix in the default format
278 Display subnet prefix in integer format, for example:
284 The following parameters may be set with
286 .Bl -tag -width indent
291 Introduced for compatibility
295 Establish an additional network address for this interface.
296 This is sometimes useful when changing network numbers, and
297 one wishes to accept packets addressed to the old interface.
298 If the address is on the same subnet as the first network address
299 for this interface, a non-conflicting netmask must be given.
304 Remove the network address specified.
305 This would be used if you incorrectly specified an alias, or it
306 was no longer needed.
307 If you have incorrectly set an NS address having the side effect
308 of specifying the host portion, removing all NS addresses will
309 allow you to respecify the host portion.
312 Specify that the address configured is an anycast address.
313 Based on the current specification,
314 only routers may configure anycast addresses.
315 Anycast address will not be used as source address of any of outgoing
318 Enable the use of the Address Resolution Protocol
321 between network level addresses and link level addresses (default).
322 This is currently implemented for mapping between
327 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
329 Disable the use of the Address Resolution Protocol
332 If the Address Resolution Protocol is enabled,
333 the host will only reply to requests for its addresses,
334 and will never send any requests.
336 If the Address Resolution Protocol is enabled,
337 the host will perform normally,
338 sending out requests and listening for replies.
341 Specify the address to use to represent broadcasts to the
343 The default broadcast address is the address with a host part of all 1's.
345 Enable driver dependent debugging code; usually, this turns on
346 extra console error logging.
348 Disable driver dependent debugging code.
350 Put interface into permanently promiscuous mode.
352 Disable permanently promiscuous mode.
357 .It Cm description Ar value , Cm descr Ar value
358 Specify a description of the interface.
359 This can be used to label interfaces in situations where they may
360 otherwise be difficult to distinguish.
361 .It Cm -description , Cm -descr
362 Clear the interface description.
366 When an interface is marked
368 the system will not attempt to
369 transmit messages through that interface.
370 If possible, the interface will be reset to disable reception as well.
371 This action does not automatically disable routes using the interface.
372 .It Cm group Ar group-name
373 Assign the interface to a
375 Any interface can be in multiple groups.
377 Cloned interfaces are members of their interface family group by default.
378 For example, a PPP interface such as
380 is a member of the PPP interface family group,
382 .\" The interface(s) the default route(s) point to are members of the
385 .It Cm -group Ar group-name
386 Remove the interface from the given
391 (lowermost 64bit of an IPv6 address)
393 .It Cm fib Ar fib_number
394 Specify interface FIB.
397 is assigned to all frames or packets received on that interface.
398 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
399 the default FIB (0) irrespective of the parent interface's FIB.
400 The kernel needs to be tuned to support more than the default FIB
403 kernel configuration option, or the
406 .It Cm tunnelfib Ar fib_number
410 is assigned to all packets encapsulated by tunnel interface, e.g.,
414 .It Cm maclabel Ar label
415 If Mandatory Access Control support is enabled in the kernel,
419 .\" .Xr maclabel 7 ) .
421 If the driver supports the media selection system, set the media type
424 Some interfaces support the mutually exclusive use of one of several
425 different physical media connectors.
426 For example, a 10Mbit/s Ethernet
427 interface might support the use of either
429 or twisted pair connectors.
430 Setting the media type to
432 would change the currently active connector to the AUI port.
435 would activate twisted pair.
436 Refer to the interfaces' driver
437 specific documentation or man page for a complete list of the
439 .It Cm mediaopt Ar opts
440 If the driver supports the media selection system, set the specified
441 media options on the interface.
445 is a comma delimited list of options to apply to the interface.
446 Refer to the interfaces' driver specific man page for a complete
447 list of available options.
448 .It Fl mediaopt Ar opts
449 If the driver supports the media selection system, disable the
450 specified media options on the interface.
452 If the driver supports the media selection system, set the specified
453 operating mode on the interface to
455 For IEEE 802.11 wireless interfaces that support multiple operating modes
456 this directive is used to select between 802.11a
463 .It Cm inst Ar minst , Cm instance Ar minst
464 Set the media instance to
466 This is useful for devices which have multiple physical layer interfaces
469 Set the interface name to
471 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
472 If the driver supports user-configurable checksum offloading,
473 enable receive (or transmit) checksum offloading on the interface.
474 The feature can be turned on selectively per protocol family.
476 .Cm rxcsum6 , txcsum6
482 Some drivers may not be able to enable these flags independently
483 of each other, so setting one may also set the other.
484 The driver will offload as much checksum work as it can reliably
485 support, the exact level of offloading varies between drivers.
486 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
487 If the driver supports user-configurable checksum offloading,
488 disable receive (or transmit) checksum offloading on the interface.
489 The feature can be turned off selectively per protocol family.
491 .Fl rxcsum6 , txcsum6
497 These settings may not always be independent of each other.
499 If the driver supports
501 segmentation offloading, enable TSO on the interface.
502 Some drivers may not be able to support TSO for
506 packets, so they may enable only one of them.
508 If the driver supports
510 segmentation offloading, disable TSO on the interface.
511 It will always disable TSO for
516 If the driver supports
518 segmentation offloading for
522 use one of these to selectively enabled it only for one protocol family.
524 If the driver supports
526 segmentation offloading for
530 use one of these to selectively disable it only for one protocol family.
532 If the driver supports
534 large receive offloading, enable LRO on the interface.
536 If the driver supports
538 large receive offloading, disable LRO on the interface.
539 .It Cm wol , wol_ucast , wol_mcast , wol_magic
540 Enable Wake On Lan (WOL) support, if available.
541 WOL is a facility whereby a machine in a low power state may be woken
542 in response to a received packet.
543 There are three types of packets that may wake a system:
544 ucast (directed solely to the machine's mac address),
545 mcast (directed to a broadcast or multicast address),
547 magic (unicast or multicast frames with a ``magic contents'').
548 Not all devices support WOL, those that do indicate the mechanisms
549 they support in their capabilities.
551 is a synonym for enabling all available WOL mechanisms.
554 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
555 If the driver offers user-configurable VLAN support, enable
556 reception of extended frames, tag processing in hardware,
557 frame filtering in hardware, checksum offloading, or TSO on VLAN,
559 Note that this must be issued on a physical interface associated with
564 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
565 If the driver offers user-configurable VLAN support, disable
566 reception of extended frames, tag processing in hardware,
567 frame filtering in hardware, or TSO on VLAN,
570 Move the interface to the
572 specified by name or JID.
573 If the jail has a virtual network stack, the interface will disappear
574 from the current environment and become visible to the jail.
576 Reclaim the interface from the
578 specified by name or JID.
579 If the jail has a virtual network stack, the interface will disappear
580 from the jail, and become visible to the current network environment.
584 feature and disable interrupts on the interface, if driver supports
589 feature and enable interrupt mode on the interface.
591 Create the specified network pseudo-device.
592 If the interface is given without a unit number, try to create a new
593 device with an arbitrary unit number.
594 If creation of an arbitrary device is successful, the new device name is
595 printed to standard output unless the interface is renamed or destroyed
600 Destroy the specified network pseudo-device.
616 Set the routing metric of the interface to
619 The routing metric is used by the routing protocol
621 Higher metrics have the effect of making a route
622 less favorable; metrics are counted as additional hops
623 to the destination network or host.
625 Set the maximum transmission unit of the interface to
627 default is interface specific.
628 The MTU is used to limit the size of packets that are transmitted on an
630 Not all interfaces support setting the MTU, and some interfaces have
632 .It Cm netmask Ar mask
635 Specify how much of the address to reserve for subdividing
636 networks into sub-networks.
637 The mask includes the network part of the local address
638 and the subnet part, which is taken from the host field of the address.
639 The mask can be specified as a single hexadecimal number
642 with a dot-notation Internet address,
643 or with a pseudo-network name listed in the network table
645 The mask contains 1's for the bit positions in the 32-bit address
646 which are to be used for the network and subnet parts,
647 and 0's for the host part.
648 The mask should contain at least the standard network portion,
649 and the subnet field should be contiguous with the network
652 The netmask can also be specified in CIDR notation after the address.
655 option above for more information.
656 .It Cm prefixlen Ar len
660 bits are reserved for subdividing networks into sub-networks.
663 must be integer, and for syntactical reason it must be between 0 to 128.
664 It is almost always 64 under the current IPv6 assignment rule.
665 If the parameter is omitted, 64 is used.
667 The prefix can also be specified using the slash notation after the address.
670 option above for more information.
675 Introduced for compatibility
679 .It Cm link Op Cm 0 No - Cm 2
681 Enable special processing of the link level of the interface.
682 These three options are interface specific in actual effect, however,
683 they are in general used to select special modes of operation.
685 of this is to enable SLIP compression, or to select the connector type
686 for some Ethernet cards.
687 Refer to the man page for the specific driver
688 for more information.
690 .It Fl link Op Cm 0 No - Cm 2
692 Disable special processing at the link level with the specified interface.
694 Put the interface in monitor mode.
695 No packets are transmitted, and received packets are discarded after
699 Take the interface out of monitor mode.
703 This may be used to enable an interface after an
705 It happens automatically when setting the first address on an interface.
706 If the interface was reset when previously marked down,
707 the hardware will be re-initialized.
710 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
711 Note that the address family keyword
714 .Bl -tag -width indent
716 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
720 .Va net.inet6.ip6.accept_rtadv
721 controls whether this flag is set by default or not.
726 Set a flag to accept router advertisements on an interface.
728 Disable autoconfiguration.
730 Set a flag to control whether routers from which the system accepts
731 Router Advertisement messages will be added to the Default Router List
735 flag is disabled, this flag has no effect.
739 .Va net.inet6.ip6.no_radr
740 controls whether this flag is set by default or not.
744 .It Cm auto_linklocal
745 Set a flag to perform automatic link-local address configuration when
746 the interface becomes available.
750 .Va net.inet6.ip6.auto_linklocal
751 controls whether this flag is set by default or not.
752 .It Cm -auto_linklocal
756 Set the specified interface as the default route when there is no
762 Set a flag to disable all of IPv6 network communications on the
764 Note that if there are already configured IPv6
765 addresses on that interface, all of them are marked as
767 and DAD will be performed when this flag is cleared.
771 When this flag is cleared and
773 flag is enabled, automatic configuration of a link-local address is
776 Set a flag to enable Neighbor Unreachability Detection.
780 .It Cm no_prefer_iface
781 Set a flag to not honor rule 5 of source address selection in RFC 3484.
782 In practice this means the address on the outgoing interface will not be
783 preferred, effectively yielding the decision to the address selection
784 policy table, configurable with
786 .It Cm -no_prefer_iface
788 .Cm no_prefer_iface .
790 Set a flag to disable Duplicate Address Detection.
796 The following parameters are specific for IPv6 addresses.
797 Note that the address family keyword
800 .Bl -tag -width indent
802 Set the IPv6 deprecated address bit.
804 Clear the IPv6 deprecated address bit.
806 Set preferred lifetime for the address.
808 Set a flag to prefer address as a candidate of the source address for
810 .It Cm -prefer_source
814 Set valid lifetime for the address.
817 The following parameters are specific to cloning
818 IEEE 802.11 wireless interfaces with the
821 .Bl -tag -width indent
822 .It Cm wlandev Ar device
825 as the parent for the cloned device.
826 .It Cm wlanmode Ar mode
827 Specify the operating mode for this cloned device.
845 The operating mode of a cloned interface cannot be changed.
848 mode is actually implemented as an
850 interface with special properties.
851 .It Cm wlanbssid Ar bssid
852 The 802.11 mac address to use for the bssid.
853 This must be specified at create time for a legacy
856 .It Cm wlanaddr Ar address
857 The local mac address.
858 If this is not specified then a mac address will automatically be assigned
859 to the cloned device.
860 Typically this address is the same as the address of the parent device
863 parameter is specified then the driver will craft a unique address for
864 the device (if supported).
868 device as operating in ``legacy mode''.
871 devices have a fixed peer relationship and do not, for example, roam
872 if their peer stops communicating.
873 For completeness a Dynamic WDS (DWDS) interface may marked as
876 Request a unique local mac address for the cloned device.
877 This is only possible if the device supports multiple mac addresses.
878 To force use of the parent's mac address use
881 Mark the cloned interface as depending on hardware support to
882 track received beacons.
883 To have beacons tracked in software use
889 can also be used to indicate no beacons should
890 be transmitted; this can be useful when creating a WDS configuration but
892 interfaces can only be created as companions to an access point.
895 The following parameters are specific to IEEE 802.11 wireless interfaces
899 .Bl -tag -width indent
901 Enable sending and receiving AMPDU frames when using 802.11n (default).
902 The 802.11n specification states a compliant station must be capable
903 of receiving AMPDU frames but transmission is optional.
906 to disable all use of AMPDU with 802.11n.
907 For testing and/or to work around interoperability problems one can use
911 to control use of AMPDU in one direction.
912 .It Cm ampdudensity Ar density
913 Set the AMPDU density parameter used when operating with 802.11n.
914 This parameter controls the inter-packet gap for AMPDU frames.
915 The sending device normally controls this setting but a receiving station
916 may request wider gaps.
919 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
922 is treated the same as 0.
923 .It Cm ampdulimit Ar limit
924 Set the limit on packet size for receiving AMPDU frames when operating
928 are 8192, 16384, 32768, and 65536 but one can also specify
929 just the unique prefix: 8, 16, 32, 64.
930 Note the sender may limit the size of AMPDU frames to be less
931 than the maximum specified by the receiving station.
933 Enable sending and receiving AMSDU frames when using 802.11n.
934 By default AMSDU is received but not transmitted.
937 to disable all use of AMSDU with 802.11n.
938 For testing and/or to work around interoperability problems one can use
942 to control use of AMSDU in one direction.
943 .It Cm amsdulimit Ar limit
944 Set the limit on packet size for sending and receiving AMSDU frames
945 when operating with 802.11n.
948 are 7935 and 3839 (bytes).
949 Note the sender may limit the size of AMSDU frames to be less
950 than the maximum specified by the receiving station.
951 Note also that devices are not required to support the 7935 limit,
952 only 3839 is required by the specification and the larger value
953 may require more memory to be dedicated to support functionality
956 When operating as an access point, pass packets between
957 wireless clients directly (default).
958 To instead let them pass up through the
959 system and be forwarded using some other mechanism, use
961 Disabling the internal bridging
962 is useful when traffic is to be processed with
964 .It Cm authmode Ar mode
965 Set the desired authentication mode in infrastructure mode.
966 Not all adapters support all modes.
969 .Cm none , open , shared
975 (IEEE WPA/WPA2/802.11i).
980 modes are only useful when using an authentication service
981 (a supplicant for client operation or an authenticator when
982 operating as an access point).
983 Modes are case insensitive.
985 Enable background scanning when operating as a station.
986 Background scanning is a technique whereby a station associated to
987 an access point will temporarily leave the channel to scan for
988 neighboring stations.
989 This allows a station to maintain a cache of nearby access points
990 so that roaming between access points can be done without
991 a lengthy scan operation.
992 Background scanning is done only when a station is not busy and
993 any outbound traffic will cancel a scan operation.
994 Background scanning should never cause packets to be lost though
995 there may be some small latency if outbound traffic interrupts a
997 By default background scanning is enabled if the device is capable.
998 To disable background scanning, use
1000 Background scanning is controlled by the
1005 Background scanning must be enabled for roaming; this is an artifact
1006 of the current implementation and may not be required in the future.
1007 .It Cm bgscanidle Ar idletime
1008 Set the minimum time a station must be idle (not transmitting or
1009 receiving frames) before a background scan is initiated.
1012 parameter is specified in milliseconds.
1013 By default a station must be idle at least 250 milliseconds before
1014 a background scan is initiated.
1015 The idle time may not be set to less than 100 milliseconds.
1016 .It Cm bgscanintvl Ar interval
1017 Set the interval at which background scanning is attempted.
1020 parameter is specified in seconds.
1021 By default a background scan is considered every 300 seconds (5 minutes).
1024 may not be set to less than 15 seconds.
1025 .It Cm bintval Ar interval
1026 Set the interval at which beacon frames are sent when operating in
1030 parameter is specified in TU's (1024 usecs).
1031 By default beacon frames are transmitted every 100 TU's.
1032 .It Cm bmissthreshold Ar count
1033 Set the number of consecutive missed beacons at which the station
1034 will attempt to roam (i.e., search for a new access point).
1037 parameter must be in the range 1 to 255; though the
1038 upper bound may be reduced according to device capabilities.
1039 The default threshold is 7 consecutive missed beacons; but
1040 this may be overridden by the device driver.
1041 Another name for the
1045 .It Cm bssid Ar address
1046 Specify the MAC address of the access point to use when operating
1047 as a station in a BSS network.
1048 This overrides any automatic selection done by the system.
1049 To disable a previously selected access point, supply
1054 This option is useful when more than one access point uses the same SSID.
1055 Another name for the
1060 Enable packet bursting.
1061 Packet bursting is a transmission technique whereby the wireless
1062 medium is acquired once to send multiple frames and the interframe
1064 This technique can significantly increase throughput by reducing
1065 transmission overhead.
1066 Packet bursting is supported by the 802.11e QoS specification
1067 and some devices that do not support QoS may still be capable.
1068 By default packet bursting is enabled if a device is capable
1070 To disable packet bursting, use
1072 .It Cm chanlist Ar channels
1073 Set the desired channels to use when scanning for access
1074 points, neighbors in an IBSS network, or looking for unoccupied
1075 channels when operating as an access point.
1076 The set of channels is specified as a comma-separated list with
1077 each element in the list representing either a single channel number or a range
1080 Channel numbers must be in the range 1 to 255 and be permissible
1081 according to the operating characteristics of the device.
1082 .It Cm channel Ar number
1083 Set a single desired channel.
1084 Channels range from 1 to 255, but the exact selection available
1085 depends on the region your adaptor was manufactured for.
1091 will clear any desired channel and, if the device is marked up,
1092 force a scan for a channel to operate on.
1093 Alternatively the frequency, in megahertz, may be specified
1094 instead of the channel number.
1096 When there are several ways to use a channel the channel
1097 number/frequency may be appended with attributes to clarify.
1098 For example, if a device is capable of operating on channel 6
1099 with 802.11n and 802.11g then one can specify that g-only use
1100 should be used by specifying ``6:g''.
1101 Similarly the channel width can be specified by appending it
1102 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1103 These attributes can be combined as in: ``6:ht/40''.
1104 The full set of flags specified following a ``:'' are:
1110 (Atheros Dynamic Turbo mode),
1118 (Atheros Static Turbo mode),
1121 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1122 The full set of channel widths following a '/' are:
1124 (5MHz aka quarter-rate channel),
1126 (10MHz aka half-rate channel),
1128 (20MHz mostly for use in specifying ht20),
1131 (40MHz mostly for use in specifying ht40).
1133 a 40MHz HT channel specification may include the location
1134 of the extension channel by appending ``+'' or ``-'' for above and below,
1135 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1136 with the center channel at frequency 2437 and the extension channel above.
1137 .It Cm country Ar name
1138 Set the country code to use in calculating the regulatory constraints
1140 In particular the set of available channels, how the wireless device
1141 will operation on the channels, and the maximum transmit power that
1142 can be used on a channel are defined by this setting.
1143 Country/Region codes are specified as a 2-character abbreviation
1144 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1145 e.g., "ES" and "Spain".
1146 The set of country codes are taken from
1147 .Pa /etc/regdomain.xml
1149 be viewed with the ``list countries'' request.
1150 Note that not all devices support changing the country code from a default
1151 setting; typically stored in EEPROM.
1159 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1160 DFS embodies several facilities including detection of overlapping
1161 radar signals, dynamic transmit power control, and channel selection
1162 according to a least-congested criteria.
1163 DFS support is mandatory for some 5GHz frequencies in certain
1164 locales (e.g., ETSI).
1165 By default DFS is enabled according to the regulatory definitions
1167 .Pa /etc/regdomain.xml
1168 and the current country code, regdomain,
1170 Note the underlying device (and driver) must support radar detection
1171 for full DFS support to work.
1172 To be fully compliant with the local regulatory agency frequencies that
1173 require DFS should not be used unless it is fully supported.
1176 to disable this functionality for testing.
1178 Enable support for the 802.11d specification (default).
1179 When this support is enabled in station mode, beacon frames that advertise
1180 a country code different than the currently configured country code will
1181 cause an event to be dispatched to user applications.
1182 This event can be used by the station to adopt that country code and
1183 operate according to the associated regulatory constraints.
1184 When operating as an access point with 802.11d enabled the beacon and
1185 probe response frames transmitted will advertise the current regulatory
1187 To disable 802.11d use
1190 Enable 802.11h support including spectrum management.
1191 When 802.11h is enabled beacon and probe response frames will have
1192 the SpectrumMgt bit set in the capabilities field and
1193 country and power constraint information elements will be present.
1194 802.11h support also includes handling Channel Switch Announcements (CSA)
1195 which are a mechanism to coordinate channel changes by an access point.
1196 By default 802.11h is enabled if the device is capable.
1197 To disable 802.11h use
1199 .It Cm deftxkey Ar index
1200 Set the default key to use for transmission.
1201 Typically this is only set when using WEP encryption.
1202 Note that you must set a default transmit key
1203 for the system to know which key to use in encrypting outbound traffic.
1206 is an alias for this request; it is provided for backwards compatibility.
1207 .It Cm dtimperiod Ar period
1210 period for transmitting buffered multicast data frames when
1211 operating in ap mode.
1214 specifies the number of beacon intervals between DTIM
1215 and must be in the range 1 to 15.
1216 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1218 Enable the use of quiet IE.
1219 Hostap will use this to silence other
1220 stations to reduce interference for radar detection when
1221 operating on 5GHz frequency and doth support is enabled.
1224 to disable this functionality.
1225 .It Cm quiet_period Ar period
1228 to the number of beacon intervals between the start of regularly
1229 scheduled quiet intervals defined by Quiet element.
1230 .It Cm quiet_count Ar count
1233 to the number of TBTTs until the beacon interval during which the
1234 next quiet interval shall start.
1235 A value of 1 indicates the quiet
1236 interval will start during the beacon interval starting at the next
1238 A value 0 is reserved.
1239 .It Cm quiet_offset Ar offset
1242 to the offset of the start of the quiet interval from the TBTT
1243 specified by the Quiet count, expressed in TUs.
1246 shall be less than one beacon interval.
1247 .It Cm quiet_duration Ar dur
1250 to the duration of the Quiet interval, expressed in TUs.
1251 The value should be less than beacon interval.
1253 Enable the use of Atheros Dynamic Turbo mode when communicating with
1254 another Dynamic Turbo-capable station.
1255 Dynamic Turbo mode is an Atheros-specific mechanism by which
1256 stations switch between normal 802.11 operation and a ``boosted''
1257 mode in which a 40MHz wide channel is used for communication.
1258 Stations using Dynamic Turbo mode operate boosted only when the
1259 channel is free of non-dturbo stations; when a non-dturbo station
1260 is identified on the channel all stations will automatically drop
1261 back to normal operation.
1262 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1263 Note that turbo mode (dynamic or static) is only allowed on some
1264 channels depending on the regulatory constraints; use the
1266 command to identify the channels where turbo mode may be used.
1267 To disable Dynamic Turbo mode use
1270 Enable Dynamic WDS (DWDS) support.
1271 DWDS is a facility by which 4-address traffic can be carried between
1272 stations operating in infrastructure mode.
1273 A station first associates to an access point and authenticates using
1274 normal procedures (e.g., WPA).
1275 Then 4-address frames are passed to carry traffic for stations
1276 operating on either side of the wireless link.
1277 DWDS extends the normal WDS mechanism by leveraging existing security
1278 protocols and eliminating static binding.
1280 When DWDS is enabled on an access point 4-address frames received from
1281 an authorized station will generate a ``DWDS discovery'' event to user
1283 This event should be used to create a WDS interface that is bound
1284 to the remote station (and usually plumbed into a bridge).
1285 Once the WDS interface is up and running 4-address traffic then logically
1286 flows through that interface.
1288 When DWDS is enabled on a station, traffic with a destination address
1289 different from the peer station are encapsulated in a 4-address frame
1290 and transmitted to the peer.
1291 All 4-address traffic uses the security information of the stations
1292 (e.g., cryptographic keys).
1293 A station is associated using 802.11n facilities may transport
1294 4-address traffic using these same mechanisms; this depends on available
1295 resources and capabilities of the device.
1296 The DWDS implementation guards against layer 2 routing loops of
1299 Enable the use of Atheros Fast Frames when communicating with
1300 another Fast Frames-capable station.
1301 Fast Frames are an encapsulation technique by which two 802.3
1302 frames are transmitted in a single 802.11 frame.
1303 This can noticeably improve throughput but requires that the
1304 receiving station understand how to decapsulate the frame.
1305 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1306 protocol extension so enabling use is safe when communicating with
1307 non-Atheros devices.
1308 By default, use of fast frames is enabled if the device is capable.
1309 To explicitly disable fast frames, use
1311 .It Cm fragthreshold Ar length
1312 Set the threshold for which transmitted frames are broken into fragments.
1315 argument is the frame size in bytes and must be in the range 256 to 2346.
1323 disables transmit fragmentation.
1324 Not all adapters honor the fragmentation threshold.
1326 When operating as an access point, do not broadcast the SSID
1327 in beacon frames or respond to probe request frames unless
1328 they are directed to the ap (i.e., they include the ap's SSID).
1329 By default, the SSID is included in beacon frames and
1330 undirected probe request frames are answered.
1331 To re-enable the broadcast of the SSID etc., use
1334 Enable use of High Throughput (HT) when using 802.11n (default).
1335 The 802.11n specification includes mechanisms for operation
1336 on 20MHz and 40MHz wide channels using different signalling mechanisms
1337 than specified in 802.11b, 802.11g, and 802.11a.
1338 Stations negotiate use of these facilities, termed HT20 and HT40,
1339 when they associate.
1340 To disable all use of 802.11n use
1342 To disable use of HT20 (e.g., to force only HT40 use) use
1344 To disable use of HT40 use
1347 HT configuration is used to ``auto promote'' operation
1348 when several choices are available.
1349 For example, if a station associates to an 11n-capable access point
1350 it controls whether the station uses legacy operation, HT20, or HT40.
1351 When an 11n-capable device is setup as an access point and
1352 Auto Channel Selection is used to locate a channel to operate on,
1353 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1354 on the selected channel.
1355 If a fixed channel is specified for a station then HT configuration can
1356 be given as part of the channel specification; e.g., 6:ht/20 to setup
1357 HT20 operation on channel 6.
1359 Enable use of compatibility support for pre-802.11n devices (default).
1360 The 802.11n protocol specification went through several incompatible iterations.
1361 Some vendors implemented 11n support to older specifications that
1362 will not interoperate with a purely 11n-compliant station.
1363 In particular the information elements included in management frames
1364 for old devices are different.
1365 When compatibility support is enabled both standard and compatible data
1367 Stations that associate using the compatibility mechanisms are flagged
1369 To disable compatibility support use
1371 .It Cm htprotmode Ar technique
1372 For interfaces operating in 802.11n, use the specified
1374 for protecting HT frames in a mixed legacy/HT network.
1375 The set of valid techniques is
1380 Technique names are case insensitive.
1382 Enable inactivity processing for stations associated to an
1383 access point (default).
1384 When operating as an access point the 802.11 layer monitors
1385 the activity of each associated station.
1386 When a station is inactive for 5 minutes it will send several
1387 ``probe frames'' to see if the station is still present.
1388 If no response is received then the station is deauthenticated.
1389 Applications that prefer to handle this work can disable this
1393 Set the location to use in calculating regulatory constraints.
1394 The location is also advertised in beacon and probe response frames
1395 when 802.11d is enabled with
1404 Display the list of channels available for use taking into account
1405 any restrictions set with the
1408 See the description of
1410 for more information.
1412 Display the adaptor's capabilities, including the operating
1415 Display the list of channels available for use.
1416 Channels are shown with their IEEE channel number, equivalent
1417 frequency, and usage modes.
1418 Channels identified as
1423 Channels identified as
1425 may be used only for Atheros' Static Turbo mode
1427 . Cm mediaopt turbo ) .
1428 Channels marked with a
1430 have a regulatory constraint that they be passively scanned.
1431 This means a station is not permitted to transmit on the channel until
1432 it identifies the channel is being used for 802.11 communication;
1433 typically by hearing a beacon frame from an access point operating
1436 is another way of requesting this information.
1437 By default a compacted list of channels is displayed; if the
1439 option is specified then all channels are shown.
1440 .It Cm list countries
1441 Display the set of country codes and regulatory domains that can be
1442 used in regulatory configuration.
1444 Display the current MAC Access Control List state.
1445 Each address is prefixed with a character that indicates the
1446 current policy applied to it:
1448 indicates the address is allowed access,
1450 indicates the address is denied access,
1452 indicates the address is present but the current policy open
1453 (so the ACL is not consulted).
1455 Displays the mesh routing table, used for forwarding packets on a mesh
1457 .It Cm list regdomain
1458 Display the current regulatory settings including the available channels
1459 and transmit power caps.
1461 Display the parameters that govern roaming operation.
1463 Display the parameters that govern transmit operation.
1465 Display the transmit power caps for each channel.
1467 Display the access points and/or ad-hoc neighbors
1468 located in the vicinity.
1469 This information may be updated automatically by the adapter
1472 request or through background scanning.
1473 Depending on the capabilities of the stations the following
1474 flags can be included in the output:
1478 Indicates that the station is permitted to send/receive data frames.
1480 Extended Rate Phy (ERP).
1481 Indicates that the station is operating in an 802.11g network
1482 using extended transmit rates.
1484 High Throughput (HT).
1485 Indicates that the station is using HT transmit rates.
1486 If a `+' follows immediately after then the station associated
1487 using deprecated mechanisms supported only when
1492 Indicates that the station is operating in power save mode.
1494 Quality of Service (QoS).
1495 Indicates that the station is using QoS encapsulation for
1497 QoS encapsulation is enabled only when WME mode is enabled.
1500 Indicates that the station is doing short preamble to optionally
1501 improve throughput performance with 802.11g and 802.11b.
1503 Transitional Security Network (TSN).
1504 Indicates that the station associated using TSN; see also
1508 Wi-Fi Protected Setup (WPS).
1509 Indicates that the station associated using WPS.
1512 By default interesting information elements captured from the neighboring
1513 stations are displayed at the end of each row.
1514 Possible elements include:
1516 (station supports WME),
1518 (station supports WPA),
1520 (station supports WPS),
1522 (station supports 802.11i/RSN),
1524 (station supports 802.11n/HT communication),
1526 (station supports Atheros protocol extensions),
1528 (station supports unknown vendor-specific extensions).
1531 flag is used all the information elements and their
1532 contents will be shown.
1535 flag also enables display of long SSIDs.
1538 command is another way of requesting this information.
1540 When operating as an access point display the stations that are
1541 currently associated.
1542 When operating in ad-hoc mode display stations identified as
1543 neighbors in the IBSS.
1544 When operating in mesh mode display stations identified as
1545 neighbors in the MBSS.
1546 When operating in station mode display the access point.
1547 Capabilities advertised by the stations are described under
1551 Depending on the capabilities of the stations the following
1552 flags can be included in the output:
1556 Indicates that the station is permitted to send/receive data frames.
1558 Extended Rate Phy (ERP).
1559 Indicates that the station is operating in an 802.11g network
1560 using extended transmit rates.
1562 High Throughput (HT).
1563 Indicates that the station is using HT transmit rates.
1564 If a `+' follows immediately after then the station associated
1565 using deprecated mechanisms supported only when
1570 Indicates that the station is operating in power save mode.
1572 Quality of Service (QoS).
1573 Indicates that the station is using QoS encapsulation for
1575 QoS encapsulation is enabled only when WME mode is enabled.
1578 Indicates that the station is doing short preamble to optionally
1579 improve throughput performance with 802.11g and 802.11b.
1581 Transitional Security Network (TSN).
1582 Indicates that the station associated using TSN; see also
1586 Wi-Fi Protected Setup (WPS).
1587 Indicates that the station associated using WPS.
1590 By default information elements received from associated stations
1591 are displayed in a short form; the
1593 flag causes this information to be displayed symbolically.
1595 Display the current channel parameters to use when operating in WME mode.
1598 option is specified then both channel and BSS parameters are displayed
1599 for each AC (first channel, then BSS).
1600 When WME mode is enabled for an adaptor this information will be
1601 displayed with the regular status; this command is mostly useful
1602 for examining parameters when WME mode is disabled.
1603 See the description of the
1605 directive for information on the various parameters.
1606 .It Cm maxretry Ar count
1607 Set the maximum number of tries to use in sending unicast frames.
1608 The default setting is 6 but drivers may override this with a value
1610 .It Cm mcastrate Ar rate
1611 Set the rate for transmitting multicast/broadcast frames.
1612 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1613 This rate should be valid for the current operating conditions;
1614 if an invalid rate is specified drivers are free to chose an
1616 .It Cm mgtrate Ar rate
1617 Set the rate for transmitting management and/or control frames.
1618 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1620 Set the location to use in calculating regulatory constraints.
1621 The location is also advertised in beacon and probe response frames
1622 when 802.11d is enabled with
1631 Enable powersave operation.
1632 When operating as a client, the station will conserve power by
1633 periodically turning off the radio and listening for
1634 messages from the access point telling it there are packets waiting.
1635 The station must then retrieve the packets.
1636 Not all devices support power save operation as a client.
1637 The 802.11 specification requires that all access points support
1638 power save but some drivers do not.
1641 to disable powersave operation when operating as a client.
1642 .It Cm powersavesleep Ar sleep
1643 Set the desired max powersave sleep time in TU's (1024 usecs).
1644 By default the max powersave sleep time is 100 TU's.
1645 .It Cm protmode Ar technique
1646 For interfaces operating in 802.11g, use the specified
1648 for protecting OFDM frames in a mixed 11b/11g network.
1649 The set of valid techniques is
1655 Technique names are case insensitive.
1656 Not all devices support
1658 as a protection technique.
1660 When operating as an access point in 802.11g mode allow only
1661 11g-capable stations to associate (11b-only stations are not
1662 permitted to associate).
1663 To allow both 11g and 11b-only stations to associate, use
1666 When operating as an access point in 802.11n mode allow only
1667 HT-capable stations to associate (legacy stations are not
1668 permitted to associate).
1669 To allow both HT and legacy stations to associate, use
1671 .It Cm regdomain Ar sku
1672 Set the regulatory domain to use in calculating the regulatory constraints
1674 In particular the set of available channels, how the wireless device
1675 will operation on the channels, and the maximum transmit power that
1676 can be used on a channel are defined by this setting.
1677 Regdomain codes (SKU's) are taken from
1678 .Pa /etc/regdomain.xml
1680 be viewed with the ``list countries'' request.
1681 Note that not all devices support changing the regdomain from a default
1682 setting; typically stored in EEPROM.
1690 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1692 Note that RIFS must be supported by both the station and access point
1696 .It Cm roam:rate Ar rate
1697 Set the threshold for controlling roaming when operating in a BSS.
1700 parameter specifies the transmit rate in megabits
1701 at which roaming should be considered.
1702 If the current transmit rate drops below this setting and background scanning
1703 is enabled, then the system will check if a more desirable access point is
1704 available and switch over to it.
1705 The current scan cache contents are used if they are considered
1706 valid according to the
1708 parameter; otherwise a background scan operation is triggered before
1709 any selection occurs.
1710 Each channel type has a separate rate threshold; the default values are:
1711 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1712 .It Cm roam:rssi Ar rssi
1713 Set the threshold for controlling roaming when operating in a BSS.
1716 parameter specifies the receive signal strength in dBm units
1717 at which roaming should be considered.
1718 If the current rssi drops below this setting and background scanning
1719 is enabled, then the system will check if a more desirable access point is
1720 available and switch over to it.
1721 The current scan cache contents are used if they are considered
1722 valid according to the
1724 parameter; otherwise a background scan operation is triggered before
1725 any selection occurs.
1726 Each channel type has a separate rssi threshold; the default values are
1728 .It Cm roaming Ar mode
1729 When operating as a station, control how the system will
1730 behave when communication with the current access point
1734 argument may be one of
1736 (leave it to the hardware device to decide),
1738 (handle either in the device or the operating system\[em]as appropriate),
1740 (do nothing until explicitly instructed).
1741 By default, the device is left to handle this if it is
1742 capable; otherwise, the operating system will automatically
1743 attempt to reestablish communication.
1744 Manual mode is used by applications such as
1745 .Xr wpa_supplicant 8
1746 that want to control the selection of an access point.
1747 .It Cm rtsthreshold Ar length
1748 Set the threshold for which
1749 transmitted frames are preceded by transmission of an
1755 is the frame size in bytes and must be in the range 1 to 2346.
1763 disables transmission of RTS frames.
1764 Not all adapters support setting the RTS threshold.
1766 Initiate a scan of neighboring stations, wait for it to complete, and
1767 display all stations found.
1768 Only the super-user can initiate a scan.
1771 for information on the display.
1772 By default a background scan is done; otherwise a foreground
1773 scan is done and the station may roam to a different access point.
1776 request can be used to show recent scan results without
1777 initiating a new scan.
1778 .It Cm scanvalid Ar threshold
1779 Set the maximum time the scan cache contents are considered valid;
1780 i.e., will be used without first triggering a scan operation to
1784 parameter is specified in seconds and defaults to 60 seconds.
1785 The minimum setting for
1788 One should take care setting this threshold; if it is set too low
1789 then attempts to roam to another access point may trigger unnecessary
1790 background scan operations.
1792 Enable use of Short Guard Interval when operating in 802.11n
1794 NB: this currently enables Short GI on both HT40 and HT20 channels.
1795 To disable Short GI use
1798 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1799 when operating in 802.11n.
1800 A station operating with Static SMPS maintains only a single
1801 receive chain active (this can significantly reduce power consumption).
1805 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1806 when operating in 802.11n.
1807 A station operating with Dynamic SMPS maintains only a single
1808 receive chain active but switches to multiple receive chains when it
1809 receives an RTS frame (this can significantly reduce power consumption).
1810 Note that stations cannot distinguish between RTS/CTS intended to
1811 enable multiple receive chains and those used for other purposes.
1815 Set the desired Service Set Identifier (aka network name).
1816 The SSID is a string up to 32 characters
1817 in length and may be specified as either a normal string or in
1818 hexadecimal when preceded by
1820 Additionally, the SSID may be cleared by setting it to
1822 .It Cm tdmaslot Ar slot
1823 When operating with TDMA, use the specified
1828 is a number between 0 and the maximum number of slots in the BSS.
1829 Note that a station configured as slot 0 is a master and
1830 will broadcast beacon frames advertising the BSS;
1831 stations configured to use other slots will always
1832 scan to locate a master before they ever transmit.
1836 .It Cm tdmaslotcnt Ar cnt
1837 When operating with TDMA, setup a BSS with
1840 The slot count may be at most 8.
1841 The current implementation is only tested with two stations
1842 (i.e., point to point applications).
1843 This setting is only meaningful when a station is configured as slot 0;
1844 other stations adopt this setting from the BSS they join.
1848 .It Cm tdmaslotlen Ar len
1849 When operating with TDMA, setup a BSS such that each station has a slot
1852 The slot length must be at least 150 microseconds (1/8 TU)
1853 and no more than 65 milliseconds.
1854 Note that setting too small a slot length may result in poor channel
1855 bandwidth utilization due to factors such as timer granularity and
1857 This setting is only meaningful when a station is configured as slot 0;
1858 other stations adopt this setting from the BSS they join.
1861 is set to 10 milliseconds.
1862 .It Cm tdmabintval Ar intval
1863 When operating with TDMA, setup a BSS such that beacons are transmitted every
1865 superframes to synchronize the TDMA slot timing.
1866 A superframe is defined as the number of slots times the slot length; e.g.,
1867 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1868 The beacon interval may not be zero.
1871 causes the timers to be resynchronized more often; this can be help if
1872 significant timer drift is observed.
1877 When operating as an access point with WPA/802.11i allow legacy
1878 stations to associate using static key WEP and open authentication.
1879 To disallow legacy station use of WEP, use
1881 .It Cm txpower Ar power
1882 Set the power used to transmit frames.
1885 argument is specified in .5 dBm units.
1886 Out of range values are truncated.
1887 Typically only a few discreet power settings are available and
1888 the driver will use the setting closest to the specified value.
1889 Not all adapters support changing the transmit power.
1890 .It Cm ucastrate Ar rate
1891 Set a fixed rate for transmitting unicast frames.
1892 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1893 This rate should be valid for the current operating conditions;
1894 if an invalid rate is specified drivers are free to chose an
1896 .It Cm wepmode Ar mode
1897 Set the desired WEP mode.
1898 Not all adapters support all modes.
1899 The set of valid modes is
1905 mode explicitly tells the adaptor to allow association with access
1906 points which allow both encrypted and unencrypted traffic.
1909 means that the access point must only allow encrypted connections.
1912 is generally another name for
1914 Modes are case insensitive.
1915 .It Cm weptxkey Ar index
1916 Set the WEP key to be used for transmission.
1917 This is the same as setting the default transmission key with
1919 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1920 Set the selected WEP key.
1923 is not given, key 1 is set.
1924 A WEP key will be either 5 or 13
1925 characters (40 or 104 bits) depending on the local network and the
1926 capabilities of the adaptor.
1927 It may be specified either as a plain
1928 string or as a string of hexadecimal digits preceded by
1930 For maximum portability, hex keys are recommended;
1931 the mapping of text keys to WEP encryption is usually driver-specific.
1934 drivers do this mapping differently to
1936 A key may be cleared by setting it to
1938 If WEP is supported then there are at least four keys.
1939 Some adapters support more than four keys.
1940 If that is the case, then the first four keys
1941 (1-4) will be the standard temporary keys and any others will be adaptor
1942 specific keys such as permanent keys stored in NVRAM.
1944 Note that you must set a default transmit key with
1946 for the system to know which key to use in encrypting outbound traffic.
1948 Enable Wireless Multimedia Extensions (WME) support, if available,
1949 for the specified interface.
1950 WME is a subset of the IEEE 802.11e standard to support the
1951 efficient communication of realtime and multimedia data.
1952 To disable WME support, use
1954 Another name for this parameter is
1957 The following parameters are meaningful only when WME support is in use.
1958 Parameters are specified per-AC (Access Category) and
1959 split into those that are used by a station when acting
1960 as an access point and those for client stations in the BSS.
1961 The latter are received from the access point and may not be changed
1963 The following Access Categories are recognized:
1965 .Bl -tag -width ".Cm AC_BK" -compact
1969 best effort delivery,
1984 AC parameters are case-insensitive.
1985 Traffic classification is done in the operating system using the
1986 vlan priority associated with data frames or the
1987 ToS (Type of Service) indication in IP-encapsulated frames.
1988 If neither information is present, traffic is assigned to the
1989 Best Effort (BE) category.
1990 .Bl -tag -width indent
1992 Set the ACK policy for QoS transmissions by the local station;
1993 this controls whether or not data frames transmitted by a station
1994 require an ACK response from the receiving station.
1995 To disable waiting for an ACK use
1997 This parameter is applied only to the local station.
1999 Enable the Admission Control Mandatory (ACM) mechanism
2000 for transmissions by the local station.
2001 To disable the ACM use
2003 On stations in a BSS this parameter is read-only and indicates
2004 the setting received from the access point.
2005 NB: ACM is not supported right now.
2006 .It Cm aifs Ar ac Ar count
2007 Set the Arbitration Inter Frame Spacing (AIFS)
2008 channel access parameter to use for transmissions
2009 by the local station.
2010 On stations in a BSS this parameter is read-only and indicates
2011 the setting received from the access point.
2012 .It Cm cwmin Ar ac Ar count
2013 Set the CWmin channel access parameter to use for transmissions
2014 by the local station.
2015 On stations in a BSS this parameter is read-only and indicates
2016 the setting received from the access point.
2017 .It Cm cwmax Ar ac Ar count
2018 Set the CWmax channel access parameter to use for transmissions
2019 by the local station.
2020 On stations in a BSS this parameter is read-only and indicates
2021 the setting received from the access point.
2022 .It Cm txoplimit Ar ac Ar limit
2023 Set the Transmission Opportunity Limit channel access parameter
2024 to use for transmissions by the local station.
2025 This parameter defines an interval of time when a WME station
2026 has the right to initiate transmissions onto the wireless medium.
2027 On stations in a BSS this parameter is read-only and indicates
2028 the setting received from the access point.
2029 .It Cm bss:aifs Ar ac Ar count
2030 Set the AIFS channel access parameter to send to stations in a BSS.
2031 This parameter is meaningful only when operating in ap mode.
2032 .It Cm bss:cwmin Ar ac Ar count
2033 Set the CWmin channel access parameter to send to stations in a BSS.
2034 This parameter is meaningful only when operating in ap mode.
2035 .It Cm bss:cwmax Ar ac Ar count
2036 Set the CWmax channel access parameter to send to stations in a BSS.
2037 This parameter is meaningful only when operating in ap mode.
2038 .It Cm bss:txoplimit Ar ac Ar limit
2039 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2040 This parameter is meaningful only when operating in ap mode.
2043 Enable Wireless Privacy Subscriber support.
2044 Note that WPS support requires a WPS-capable supplicant.
2045 To disable this function use
2049 The following parameters support an optional access control list
2050 feature available with some adapters when operating in ap mode; see
2052 This facility allows an access point to accept/deny association
2053 requests based on the MAC address of the station.
2054 Note that this feature does not significantly enhance security
2055 as MAC address spoofing is easy to do.
2056 .Bl -tag -width indent
2057 .It Cm mac:add Ar address
2058 Add the specified MAC address to the database.
2059 Depending on the policy setting association requests from the
2060 specified station will be allowed or denied.
2062 Set the ACL policy to permit association only by
2063 stations registered in the database.
2064 .It Cm mac:del Ar address
2065 Delete the specified MAC address from the database.
2067 Set the ACL policy to deny association only by
2068 stations registered in the database.
2069 .It Cm mac:kick Ar address
2070 Force the specified station to be deauthenticated.
2071 This typically is done to block a station after updating the
2074 Set the ACL policy to allow all stations to associate.
2076 Delete all entries in the database.
2078 Set the ACL policy to permit association only by
2079 stations approved by a RADIUS server.
2080 Note that this feature requires the
2082 program be configured to do the right thing
2083 as it handles the RADIUS processing
2084 (and marks stations as authorized).
2087 The following parameters are related to a wireless interface operating in mesh
2089 .Bl -tag -width indent
2090 .It Cm meshid Ar meshid
2091 Set the desired Mesh Identifier.
2092 The Mesh ID is a string up to 32 characters in length.
2093 A mesh interface must have a Mesh Identifier specified
2094 to reach an operational state.
2095 .It Cm meshttl Ar ttl
2096 Set the desired ``time to live'' for mesh forwarded packets;
2097 this is the number of hops a packet may be forwarded before
2099 The default setting for
2103 Enable or disable peering with neighbor mesh stations.
2104 Stations must peer before any data packets can be exchanged.
2109 Enable or disable forwarding packets by a mesh interface.
2114 This attribute specifies whether or not the mesh STA activates mesh gate
2119 .It Cm meshmetric Ar protocol
2122 as the link metric protocol used on a mesh network.
2123 The default protocol is called
2125 The mesh interface will restart after changing this setting.
2126 .It Cm meshpath Ar protocol
2129 as the path selection protocol used on a mesh network.
2130 The only available protocol at the moment is called
2132 (Hybrid Wireless Mesh Protocol).
2133 The mesh interface will restart after changing this setting.
2134 .It Cm hwmprootmode Ar mode
2135 Stations on a mesh network can operate as ``root nodes.''
2136 Root nodes try to find paths to all mesh nodes and advertise themselves
2138 When there is a root mesh node on a network, other mesh nodes can setup
2139 paths between themselves faster because they can use the root node
2140 to find the destination.
2141 This path may not be the best, but on-demand
2142 routing will eventually find the best path.
2143 The following modes are recognized:
2145 .Bl -tag -width ".Cm PROACTIVE" -compact
2149 Send broadcast path requests every two seconds.
2150 Nodes on the mesh without a path to this root mesh station with try to
2151 discover a path to us.
2153 Send broadcast path requests every two seconds and every node must reply
2154 with a path reply even if it already has a path to this root mesh station.
2156 Send broadcast root announcement (RANN) frames.
2157 Nodes on the mesh without a path to this root mesh station with try to
2158 discover a path to us.
2164 .It Cm hwmpmaxhops Ar cnt
2165 Set the maximum number of hops allowed in an HMWP path to
2167 The default setting for
2172 The following parameters are for compatibility with other systems:
2173 .Bl -tag -width indent
2175 Another name for the
2181 .It Cm stationname Ar name
2182 Set the name of this station.
2183 The station name is not part of the IEEE 802.11
2184 protocol though some interfaces support it.
2186 seems to be meaningful to identical or virtually identical equipment.
2187 Setting the station name is identical in syntax to setting the SSID.
2194 Another way of saying
2200 Another way of saying
2206 Another way of saying:
2207 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2213 .Ar n : k1 , k2 , k3 , k4
2216 Another way of saying
2217 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2222 Another way of saying
2229 The following parameters are specific to bridge interfaces:
2230 .Bl -tag -width indent
2231 .It Cm addm Ar interface
2232 Add the interface named by
2234 as a member of the bridge.
2235 The interface is put into promiscuous mode
2236 so that it can receive every packet sent on the network.
2237 .It Cm deletem Ar interface
2238 Remove the interface named by
2241 Promiscuous mode is disabled on the interface when
2242 it is removed from the bridge.
2243 .It Cm maxaddr Ar size
2244 Set the size of the bridge address cache to
2246 The default is 2000 entries.
2247 .It Cm timeout Ar seconds
2248 Set the timeout of address cache entries to
2253 is zero, then address cache entries will not be expired.
2254 The default is 1200 seconds.
2256 Display the addresses that have been learned by the bridge.
2257 .It Cm static Ar interface-name Ar address
2258 Add a static entry into the address cache pointing to
2259 .Ar interface-name .
2260 Static entries are never aged out of the cache or re-placed, even if the
2261 address is seen on a different interface.
2262 .It Cm deladdr Ar address
2265 from the address cache.
2267 Delete all dynamically-learned addresses from the address cache.
2269 Delete all addresses, including static addresses, from the address cache.
2270 .It Cm discover Ar interface
2271 Mark an interface as a
2274 When the bridge has no address cache entry
2275 (either dynamic or static)
2276 for the destination address of a packet,
2277 the bridge will forward the packet to all
2278 member interfaces marked as
2280 This is the default for all interfaces added to a bridge.
2281 .It Cm -discover Ar interface
2284 attribute on a member interface.
2285 For packets without the
2287 attribute, the only packets forwarded on the interface are broadcast
2288 or multicast packets and packets for which the destination address
2289 is known to be on the interface's segment.
2290 .It Cm learn Ar interface
2291 Mark an interface as a
2294 When a packet arrives on such an interface, the source
2295 address of the packet is entered into the address cache as being a
2296 destination address on the interface's segment.
2297 This is the default for all interfaces added to a bridge.
2298 .It Cm -learn Ar interface
2301 attribute on a member interface.
2302 .It Cm sticky Ar interface
2303 Mark an interface as a
2306 Dynamically learned address entries are treated at static once entered into
2308 Sticky entries are never aged out of the cache or replaced, even if the
2309 address is seen on a different interface.
2310 .It Cm -sticky Ar interface
2313 attribute on a member interface.
2314 .It Cm private Ar interface
2315 Mark an interface as a
2318 A private interface does not forward any traffic to any other port that is also
2319 a private interface.
2320 .It Cm -private Ar interface
2323 attribute on a member interface.
2324 .It Cm span Ar interface
2325 Add the interface named by
2327 as a span port on the bridge.
2328 Span ports transmit a copy of every frame received by the bridge.
2329 This is most useful for snooping a bridged network passively on
2330 another host connected to one of the span ports of the bridge.
2331 .It Cm -span Ar interface
2332 Delete the interface named by
2334 from the list of span ports of the bridge.
2335 .It Cm stp Ar interface
2336 Enable Spanning Tree protocol on
2340 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2341 Spanning Tree is used to detect and remove loops in a network topology.
2342 .It Cm -stp Ar interface
2343 Disable Spanning Tree protocol on
2345 This is the default for all interfaces added to a bridge.
2346 .It Cm edge Ar interface
2350 An edge port connects directly to end stations cannot create bridging
2351 loops in the network, this allows it to transition straight to forwarding.
2352 .It Cm -edge Ar interface
2353 Disable edge status on
2355 .It Cm autoedge Ar interface
2358 to automatically detect edge status.
2359 This is the default for all interfaces added to a bridge.
2360 .It Cm -autoedge Ar interface
2361 Disable automatic edge status on
2363 .It Cm ptp Ar interface
2366 as a point to point link.
2367 This is required for straight transitions to forwarding and
2368 should be enabled on a direct link to another RSTP capable switch.
2369 .It Cm -ptp Ar interface
2370 Disable point to point link status on
2372 This should be disabled for a half duplex link and for an interface
2373 connected to a shared network segment,
2374 like a hub or a wireless network.
2375 .It Cm autoptp Ar interface
2376 Automatically detect the point to point status on
2378 by checking the full duplex link status.
2379 This is the default for interfaces added to the bridge.
2380 .It Cm -autoptp Ar interface
2381 Disable automatic point to point link detection on
2383 .It Cm maxage Ar seconds
2384 Set the time that a Spanning Tree protocol configuration is valid.
2385 The default is 20 seconds.
2386 The minimum is 6 seconds and the maximum is 40 seconds.
2387 .It Cm fwddelay Ar seconds
2388 Set the time that must pass before an interface begins forwarding
2389 packets when Spanning Tree is enabled.
2390 The default is 15 seconds.
2391 The minimum is 4 seconds and the maximum is 30 seconds.
2392 .It Cm hellotime Ar seconds
2393 Set the time between broadcasting of Spanning Tree protocol
2394 configuration messages.
2395 The hello time may only be changed when operating in legacy stp mode.
2396 The default is 2 seconds.
2397 The minimum is 1 second and the maximum is 2 seconds.
2398 .It Cm priority Ar value
2399 Set the bridge priority for Spanning Tree.
2400 The default is 32768.
2401 The minimum is 0 and the maximum is 61440.
2402 .It Cm proto Ar value
2403 Set the Spanning Tree protocol.
2404 The default is rstp.
2405 The available options are stp and rstp.
2406 .It Cm holdcnt Ar value
2407 Set the transmit hold count for Spanning Tree.
2408 This is the number of packets transmitted before being rate limited.
2410 The minimum is 1 and the maximum is 10.
2411 .It Cm ifpriority Ar interface Ar value
2412 Set the Spanning Tree priority of
2417 The minimum is 0 and the maximum is 240.
2418 .It Cm ifpathcost Ar interface Ar value
2419 Set the Spanning Tree path cost of
2423 The default is calculated from the link speed.
2424 To change a previously selected path cost back to automatic, set the
2426 The minimum is 1 and the maximum is 200000000.
2427 .It Cm ifmaxaddr Ar interface Ar size
2428 Set the maximum number of hosts allowed from an interface, packets with unknown
2429 source addresses are dropped until an existing host cache entry expires or is
2431 Set to 0 to disable.
2434 The following parameters are specific to lagg interfaces:
2435 .Bl -tag -width indent
2436 .It Cm laggport Ar interface
2437 Add the interface named by
2439 as a port of the aggregation interface.
2440 .It Cm -laggport Ar interface
2441 Remove the interface named by
2443 from the aggregation interface.
2444 .It Cm laggproto Ar proto
2445 Set the aggregation protocol.
2448 The available options are
2456 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2457 Set the packet layers to hash for aggregation protocols which load balance.
2460 The options can be combined using commas.
2462 .Bl -tag -width ".Cm l2" -compact
2464 src/dst mac address and optional vlan number.
2466 src/dst address for IPv4 or IPv6.
2468 src/dst port for TCP/UDP/SCTP.
2471 Enable local hash computation for RSS hash on the interface.
2476 modes will use the RSS hash from the network card if available
2477 to avoid computing one, this may give poor traffic distribution
2478 if the hash is invalid or uses less of the protocol header information.
2480 disables use of RSS hash from the network card.
2481 The default value can be set via the
2482 .Va net.link.lagg.default_use_flowid
2493 Use the RSS hash from the network card if available.
2494 .It Cm flowid_shift Ar number
2495 Set a shift parameter for RSS local hash computation.
2496 Hash is calculated by using flowid bits in a packet header mbuf
2497 which are shifted by the number of this parameter.
2498 .It Cm lacp_fast_timeout
2499 Enable lacp fast-timeout on the interface.
2500 .It Cm -lacp_fast_timeout
2501 Disable lacp fast-timeout on the interface.
2503 Enable lacp strict compliance on the interface.
2504 The default value can be set via the
2505 .Va net.link.lagg.lacp.default_strict_mode
2516 Disable lacp strict compliance on the interface.
2519 The following parameters are specific to IP tunnel interfaces,
2521 .Bl -tag -width indent
2522 .It Cm tunnel Ar src_addr dest_addr
2523 Configure the physical source and destination address for IP tunnel
2529 are interpreted as the outer source/destination for the encapsulating
2532 Unconfigure the physical source and destination address for IP tunnel
2533 interfaces previously configured with
2536 Another name for the
2539 .It Cm accept_rev_ethip_ver
2540 Set a flag to accept both correct EtherIP packets and ones
2541 with reversed version field.
2543 This is for backward compatibility with
2545 6.2, 6.3, 7.0, and 7.1.
2546 .It Cm -accept_rev_ethip_ver
2548 .Cm accept_rev_ethip_ver .
2549 .It Cm ignore_source
2550 Set a flag to accept encapsulated packets destined to this host
2551 independently from source address.
2552 This may be useful for hosts, that receive encapsulated packets
2553 from the load balancers.
2554 .It Cm -ignore_source
2557 .It Cm send_rev_ethip_ver
2558 Set a flag to send EtherIP packets with reversed version
2559 field intentionally.
2560 Disabled by default.
2561 This is for backward compatibility with
2563 6.2, 6.3, 7.0, and 7.1.
2564 .It Cm -send_rev_ethip_ver
2566 .Cm send_rev_ethip_ver .
2569 The following parameters are specific to GRE tunnel interfaces,
2571 .Bl -tag -width indent
2572 .It Cm grekey Ar key
2573 Configure the GRE key to be used for outgoing packets.
2575 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2576 This command will result in a four byte MTU reduction on the interface.
2579 The following parameters are specific to
2582 .Bl -tag -width indent
2583 .It Cm syncdev Ar iface
2584 Use the specified interface
2585 to send and receive pfsync state synchronisation messages.
2587 Stop sending pfsync state synchronisation messages over the network.
2588 .It Cm syncpeer Ar peer_address
2589 Make the pfsync link point-to-point rather than using
2590 multicast to broadcast the state synchronisation messages.
2591 The peer_address is the IP address of the other host taking part in
2594 Broadcast the packets using multicast.
2596 Set the maximum number of updates for a single state which
2597 can be collapsed into one.
2598 This is an 8-bit number; the default value is 128.
2600 Defer transmission of the first packet in a state until a peer has
2601 acknowledged that the associated state has been inserted.
2603 Do not defer the first packet in a state.
2604 This is the default.
2607 The following parameters are specific to
2610 .Bl -tag -width indent
2611 .It Cm vlan Ar vlan_tag
2612 Set the VLAN tag value to
2614 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2615 VLAN header for packets sent from the
2622 must both be set at the same time.
2623 .It Cm vlanpcp Ar priority_code_point
2626 is an 3-bit field which refers to the IEEE 802.1p
2627 class of service and maps to the frame priority level.
2629 Values in order of priority are:
2631 .Pq Dv Background (lowest) ,
2633 .Pq Dv Best effort (default) ,
2635 .Pq Dv Excellent effort ,
2637 .Pq Dv Critical applications ,
2639 .Pq Dv Video, < 100ms latency ,
2641 .Pq Dv Video, < 10ms latency ,
2643 .Pq Dv Internetwork control ,
2645 .Pq Dv Network control (highest) .
2646 .It Cm vlandev Ar iface
2647 Associate the physical interface
2652 Packets transmitted through the
2655 diverted to the specified physical interface
2657 with 802.1Q VLAN encapsulation.
2658 Packets with 802.1Q encapsulation received
2659 by the parent interface with the correct VLAN Identifier will be diverted to
2665 interface is assigned a
2666 copy of the parent interface's flags and the parent's Ethernet address.
2671 must both be set at the same time.
2674 interface already has
2675 a physical interface associated with it, this command will fail.
2677 change the association to another physical interface, the existing
2678 association must be cleared first.
2680 Note: if the hardware tagging capability
2681 is set on the parent interface, the
2684 interface's behavior changes:
2687 interface recognizes that the
2688 parent interface supports insertion and extraction of VLAN tags on its
2689 own (usually in firmware) and that it should pass packets to and from
2690 the parent unaltered.
2691 .It Fl vlandev Op Ar iface
2694 pseudo device, disassociate the parent interface from it.
2695 This breaks the link between the
2697 interface and its parent,
2698 clears its VLAN Identifier, flags and its link address and shuts the interface
2702 argument is useless and hence deprecated.
2705 The following parameters are used to configure
2708 .Bl -tag -width indent
2709 .It Cm vxlanid Ar identifier
2710 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2711 virtual network segment membership of the interface.
2712 .It Cm vxlanlocal Ar address
2713 The source address used in the encapsulating IPv4/IPv6 header.
2714 The address should already be assigned to an existing interface.
2715 When the interface is configured in unicast mode, the listening socket
2716 is bound to this address.
2717 .It Cm vxlanremote Ar address
2718 The interface can be configured in a unicast, or point-to-point, mode
2719 to create a tunnel between two hosts.
2720 This is the IP address of the remote end of the tunnel.
2721 .It Cm vxlangroup Ar address
2722 The interface can be configured in a multicast mode
2723 to create a virtual network of hosts.
2724 This is the IP multicast group address the interface will join.
2725 .It Cm vxlanlocalport Ar port
2726 The port number the interface will listen on.
2727 The default port number is 4789.
2728 .It Cm vxlanremoteport Ar port
2729 The destination port number used in the encapsulating IPv4/IPv6 header.
2730 The remote host should be listening on this port.
2731 The default port number is 4789.
2732 Note some other implementations, such as Linux,
2733 do not default to the IANA assigned port,
2734 but instead listen on port 8472.
2735 .It Cm vxlanportrange Ar low high
2736 The range of source ports used in the encapsulating IPv4/IPv6 header.
2737 The port selected within the range is based on a hash of the inner frame.
2738 A range is useful to provide entropy within the outer IP header
2739 for more effective load balancing.
2740 The default range is between the
2743 .Va net.inet.ip.portrange.first
2745 .Va net.inet.ip.portrange.last
2746 .It Cm vxlantimeout Ar timeout
2747 The maximum time, in seconds, before an entry in the forwarding table
2749 The default is 1200 seconds (20 minutes).
2750 .It Cm vxlanmaxaddr Ar max
2751 The maximum number of entries in the forwarding table.
2752 The default is 2000.
2753 .It Cm vxlandev Ar dev
2754 When the interface is configured in multicast mode, the
2756 interface is used to transmit IP multicast packets.
2757 .It Cm vxlanttl Ar ttl
2758 The TTL used in the encapsulating IPv4/IPv6 header.
2761 The source IP address and inner source Ethernet MAC address of
2762 received packets are used to dynamically populate the forwarding table.
2763 When in multicast mode, an entry in the forwarding table allows the
2764 interface to send the frame directly to the remote host instead of
2765 broadcasting the frame to the multicast group.
2766 This is the default.
2768 The forwarding table is not populated by received packets.
2770 Delete all dynamically-learned addresses from the forwarding table.
2771 .It Cm vxlanflushall
2772 Delete all addresses, including static addresses, from the forwarding table.
2775 The following parameters are used to configure
2777 protocol on an interface:
2778 .Bl -tag -width indent
2780 Set the virtual host ID.
2781 This is a required setting to initiate
2783 If the virtual host ID does not exist yet, it is created and attached to the
2784 interface, otherwise configuration of an existing vhid is adjusted.
2787 keyword is supplied along with an
2791 address, then this address is configured to be run under control of the
2793 Whenever a last address that refers to a particular vhid is removed from an
2794 interface, the vhid is automatically removed from interface and destroyed.
2795 Any other configuration parameters for the
2797 protocol should be supplied along with the
2800 Acceptable values for vhid are 1 to 255.
2801 .It Cm advbase Ar seconds
2802 Specifies the base of the advertisement interval in seconds.
2803 The acceptable values are 1 to 255.
2804 The default value is 1.
2805 .It Cm advskew Ar interval
2806 Specifies the skew to add to the base advertisement interval to
2807 make one host advertise slower than another host.
2808 It is specified in 1/256 of seconds.
2809 The acceptable values are 1 to 254.
2810 The default value is 0.
2811 .It Cm pass Ar phrase
2812 Set the authentication key to
2814 .It Cm state Ar MASTER|BACKUP
2815 Forcibly change state of a given vhid.
2820 utility displays the current configuration for a network interface
2821 when no optional parameters are supplied.
2822 If a protocol family is specified,
2824 will report only the details specific to that protocol family.
2828 flag is passed before an interface name,
2830 will display the capability list and all
2831 of the supported media for the specified interface.
2834 flag is supplied, address lifetime is displayed for IPv6 addresses,
2835 as time offset string.
2839 flag may be used instead of an interface name.
2842 to display information about all interfaces in the system.
2845 flag limits this to interfaces that are down, and
2847 limits this to interfaces that are up.
2848 When no arguments are given,
2854 flag may be used to list all available interfaces on the system, with
2855 no other additional information.
2858 is specified, only interfaces of that type will be listed.
2860 will list only Ethernet adapters, excluding the loopback interface.
2861 Use of this flag is mutually exclusive
2862 with all other flags and commands, except for
2864 (only list interfaces that are down)
2867 (only list interfaces that are up).
2871 flag may be used to get more verbose status for an interface.
2875 flag may be used to list all of the interface cloners available on
2876 the system, with no additional information.
2877 Use of this flag is mutually exclusive with all other flags and commands.
2881 flag causes keying information for the interface, if available, to be
2883 For example, the values of 802.11 WEP keys and
2885 passphrases will be printed, if accessible to the current user.
2886 This information is not printed by default, as it may be considered
2889 If the network interface driver is not present in the kernel then
2891 will attempt to load it.
2894 flag disables this behavior.
2896 Only the super-user may modify the configuration of a network interface.
2898 Assign the IPv4 address
2900 with a network mask of
2904 .Dl # ifconfig fxp0 inet 192.0.2.10 netmask 255.255.255.0
2906 Add the IPv4 address
2908 with the CIDR network prefix
2914 as a synonym for the canonical form of the option
2916 .Dl # ifconfig ed0 inet 192.0.2.45/28 add
2918 Remove the IPv4 address
2922 .Dl # ifconfig ed0 inet 192.0.2.45 -alias
2924 Enable IPv6 functionality of the interface:
2925 .Dl # ifconfig em0 inet6 -ifdisabled
2927 Add the IPv6 address
2928 .Li 2001:DB8:DBDB::123/48
2931 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2932 Note that lower case hexadecimal IPv6 addresses are acceptable.
2934 Remove the IPv6 address added in the above example,
2937 character as shorthand for the network prefix,
2940 as a synonym for the canonical form of the option
2942 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2944 Configure a single CARP redundant address on igb0, and then switch it
2946 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2947 .Dl # ifconfig igb0 vhid 1 state master
2949 Configure the interface
2951 to use 100baseTX, full duplex Ethernet media options:
2952 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2954 Label the em0 interface as an uplink:
2955 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2957 Create the software network interface
2959 .Dl # ifconfig gif1 create
2961 Destroy the software network interface
2963 .Dl # ifconfig gif1 destroy
2965 Display available wireless networks using
2967 .Dl # ifconfig wlan0 list scan
2969 Display inet and inet6 address subnet masks in CIDR notation
2970 .Dl # ifconfig -f inet:cidr,inet6:cidr
2972 Messages indicating the specified interface does not exist, the
2973 requested address is unknown, or the user is not privileged and
2974 tried to alter an interface's configuration.
2997 Basic IPv6 node operation requires a link-local address on each
2998 interface configured for IPv6.
2999 Normally, such an address is automatically configured by the
3000 kernel on each interface added to the system or enabled; this behavior may
3001 be disabled by setting per-interface flag
3002 .Cm -auto_linklocal .
3003 The default value of this flag is 1 and can be disabled by using the sysctl
3005 .Va net.inet6.ip6.auto_linklocal .
3007 Do not configure IPv6 addresses with no link-local address by using
3009 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob