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 .\" 3. 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
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
464 Set if the driver supports TX rate limiting.
465 .It Cm inst Ar minst , Cm instance Ar minst
466 Set the media instance to
468 This is useful for devices which have multiple physical layer interfaces
471 Set the interface name to
473 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
474 If the driver supports user-configurable checksum offloading,
475 enable receive (or transmit) checksum offloading on the interface.
476 The feature can be turned on selectively per protocol family.
478 .Cm rxcsum6 , txcsum6
484 Some drivers may not be able to enable these flags independently
485 of each other, so setting one may also set the other.
486 The driver will offload as much checksum work as it can reliably
487 support, the exact level of offloading varies between drivers.
488 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
489 If the driver supports user-configurable checksum offloading,
490 disable receive (or transmit) checksum offloading on the interface.
491 The feature can be turned off selectively per protocol family.
493 .Fl rxcsum6 , txcsum6
499 These settings may not always be independent of each other.
501 If the driver supports
503 segmentation offloading, enable TSO on the interface.
504 Some drivers may not be able to support TSO for
508 packets, so they may enable only one of them.
510 If the driver supports
512 segmentation offloading, disable TSO on the interface.
513 It will always disable TSO for
518 If the driver supports
520 segmentation offloading for
524 use one of these to selectively enabled it only for one protocol family.
526 If the driver supports
528 segmentation offloading for
532 use one of these to selectively disable it only for one protocol family.
534 If the driver supports
536 large receive offloading, enable LRO on the interface.
538 If the driver supports
540 large receive offloading, disable LRO on the interface.
541 .It Cm wol , wol_ucast , wol_mcast , wol_magic
542 Enable Wake On Lan (WOL) support, if available.
543 WOL is a facility whereby a machine in a low power state may be woken
544 in response to a received packet.
545 There are three types of packets that may wake a system:
546 ucast (directed solely to the machine's mac address),
547 mcast (directed to a broadcast or multicast address),
549 magic (unicast or multicast frames with a ``magic contents'').
550 Not all devices support WOL, those that do indicate the mechanisms
551 they support in their capabilities.
553 is a synonym for enabling all available WOL mechanisms.
556 .It Cm vlanmtu , vlanhwtag, vlanhwfilter, vlanhwcsum, vlanhwtso
557 If the driver offers user-configurable VLAN support, enable
558 reception of extended frames, tag processing in hardware,
559 frame filtering in hardware, checksum offloading, or TSO on VLAN,
561 Note that this must be issued on a physical interface associated with
566 .It Fl vlanmtu , vlanhwtag, vlanhwfilter, vlanhwtso
567 If the driver offers user-configurable VLAN support, disable
568 reception of extended frames, tag processing in hardware,
569 frame filtering in hardware, or TSO on VLAN,
572 Move the interface to the
574 specified by name or JID.
575 If the jail has a virtual network stack, the interface will disappear
576 from the current environment and become visible to the jail.
578 Reclaim the interface from the
580 specified by name or JID.
581 If the jail has a virtual network stack, the interface will disappear
582 from the jail, and become visible to the current network environment.
586 feature and disable interrupts on the interface, if driver supports
591 feature and enable interrupt mode on the interface.
593 Create the specified network pseudo-device.
594 If the interface is given without a unit number, try to create a new
595 device with an arbitrary unit number.
596 If creation of an arbitrary device is successful, the new device name is
597 printed to standard output unless the interface is renamed or destroyed
602 Destroy the specified network pseudo-device.
618 Set the routing metric of the interface to
621 The routing metric is used by the routing protocol
623 Higher metrics have the effect of making a route
624 less favorable; metrics are counted as additional hops
625 to the destination network or host.
627 Set the maximum transmission unit of the interface to
629 default is interface specific.
630 The MTU is used to limit the size of packets that are transmitted on an
632 Not all interfaces support setting the MTU, and some interfaces have
634 .It Cm netmask Ar mask
637 Specify how much of the address to reserve for subdividing
638 networks into sub-networks.
639 The mask includes the network part of the local address
640 and the subnet part, which is taken from the host field of the address.
641 The mask can be specified as a single hexadecimal number
644 with a dot-notation Internet address,
645 or with a pseudo-network name listed in the network table
647 The mask contains 1's for the bit positions in the 32-bit address
648 which are to be used for the network and subnet parts,
649 and 0's for the host part.
650 The mask should contain at least the standard network portion,
651 and the subnet field should be contiguous with the network
654 The netmask can also be specified in CIDR notation after the address.
657 option above for more information.
658 .It Cm prefixlen Ar len
662 bits are reserved for subdividing networks into sub-networks.
665 must be integer, and for syntactical reason it must be between 0 to 128.
666 It is almost always 64 under the current IPv6 assignment rule.
667 If the parameter is omitted, 64 is used.
669 The prefix can also be specified using the slash notation after the address.
672 option above for more information.
677 Introduced for compatibility
681 .It Cm link Op Cm 0 No - Cm 2
683 Enable special processing of the link level of the interface.
684 These three options are interface specific in actual effect, however,
685 they are in general used to select special modes of operation.
687 of this is to enable SLIP compression, or to select the connector type
688 for some Ethernet cards.
689 Refer to the man page for the specific driver
690 for more information.
692 .It Fl link Op Cm 0 No - Cm 2
694 Disable special processing at the link level with the specified interface.
696 Put the interface in monitor mode.
697 No packets are transmitted, and received packets are discarded after
701 Take the interface out of monitor mode.
705 This may be used to enable an interface after an
707 It happens automatically when setting the first address on an interface.
708 If the interface was reset when previously marked down,
709 the hardware will be re-initialized.
712 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
713 Note that the address family keyword
716 .Bl -tag -width indent
718 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
722 .Va net.inet6.ip6.accept_rtadv
723 controls whether this flag is set by default or not.
728 Set a flag to control whether routers from which the system accepts
729 Router Advertisement messages will be added to the Default Router List
733 flag is disabled, this flag has no effect.
737 .Va net.inet6.ip6.no_radr
738 controls whether this flag is set by default or not.
742 .It Cm auto_linklocal
743 Set a flag to perform automatic link-local address configuration when
744 the interface becomes available.
748 .Va net.inet6.ip6.auto_linklocal
749 controls whether this flag is set by default or not.
750 .It Cm -auto_linklocal
754 Set the specified interface as the default route when there is no
760 Set a flag to disable all of IPv6 network communications on the
762 Note that if there are already configured IPv6
763 addresses on that interface, all of them are marked as
765 and DAD will be performed when this flag is cleared.
769 When this flag is cleared and
771 flag is enabled, automatic configuration of a link-local address is
774 Set a flag to enable Neighbor Unreachability Detection.
778 .It Cm no_prefer_iface
779 Set a flag to not honor rule 5 of source address selection in RFC 3484.
780 In practice this means the address on the outgoing interface will not be
781 preferred, effectively yielding the decision to the address selection
782 policy table, configurable with
784 .It Cm -no_prefer_iface
786 .Cm no_prefer_iface .
788 Set a flag to disable Duplicate Address Detection.
794 The following parameters are specific for IPv6 addresses.
795 Note that the address family keyword
798 .Bl -tag -width indent
800 Set the IPv6 autoconfigured address bit.
802 Clear the IPv6 autoconfigured address bit.
804 Set the IPv6 deprecated address bit.
806 Clear the IPv6 deprecated address bit.
808 Set preferred lifetime for the address.
810 Set a flag to prefer address as a candidate of the source address for
812 .It Cm -prefer_source
816 Set valid lifetime for the address.
819 The following parameters are specific to cloning
820 IEEE 802.11 wireless interfaces with the
823 .Bl -tag -width indent
824 .It Cm wlandev Ar device
827 as the parent for the cloned device.
828 .It Cm wlanmode Ar mode
829 Specify the operating mode for this cloned device.
847 The operating mode of a cloned interface cannot be changed.
850 mode is actually implemented as an
852 interface with special properties.
853 .It Cm wlanbssid Ar bssid
854 The 802.11 mac address to use for the bssid.
855 This must be specified at create time for a legacy
858 .It Cm wlanaddr Ar address
859 The local mac address.
860 If this is not specified then a mac address will automatically be assigned
861 to the cloned device.
862 Typically this address is the same as the address of the parent device
865 parameter is specified then the driver will craft a unique address for
866 the device (if supported).
870 device as operating in ``legacy mode''.
873 devices have a fixed peer relationship and do not, for example, roam
874 if their peer stops communicating.
875 For completeness a Dynamic WDS (DWDS) interface may marked as
878 Request a unique local mac address for the cloned device.
879 This is only possible if the device supports multiple mac addresses.
880 To force use of the parent's mac address use
883 Mark the cloned interface as depending on hardware support to
884 track received beacons.
885 To have beacons tracked in software use
891 can also be used to indicate no beacons should
892 be transmitted; this can be useful when creating a WDS configuration but
894 interfaces can only be created as companions to an access point.
897 The following parameters are specific to IEEE 802.11 wireless interfaces
901 .Bl -tag -width indent
903 Enable sending and receiving AMPDU frames when using 802.11n (default).
904 The 802.11n specification states a compliant station must be capable
905 of receiving AMPDU frames but transmission is optional.
908 to disable all use of AMPDU with 802.11n.
909 For testing and/or to work around interoperability problems one can use
913 to control use of AMPDU in one direction.
914 .It Cm ampdudensity Ar density
915 Set the AMPDU density parameter used when operating with 802.11n.
916 This parameter controls the inter-packet gap for AMPDU frames.
917 The sending device normally controls this setting but a receiving station
918 may request wider gaps.
921 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
924 is treated the same as 0.
925 .It Cm ampdulimit Ar limit
926 Set the limit on packet size for receiving AMPDU frames when operating
930 are 8192, 16384, 32768, and 65536 but one can also specify
931 just the unique prefix: 8, 16, 32, 64.
932 Note the sender may limit the size of AMPDU frames to be less
933 than the maximum specified by the receiving station.
935 Enable sending and receiving AMSDU frames when using 802.11n.
936 By default AMSDU is received but not transmitted.
939 to disable all use of AMSDU with 802.11n.
940 For testing and/or to work around interoperability problems one can use
944 to control use of AMSDU in one direction.
945 .It Cm amsdulimit Ar limit
946 Set the limit on packet size for sending and receiving AMSDU frames
947 when operating with 802.11n.
950 are 7935 and 3839 (bytes).
951 Note the sender may limit the size of AMSDU frames to be less
952 than the maximum specified by the receiving station.
953 Note also that devices are not required to support the 7935 limit,
954 only 3839 is required by the specification and the larger value
955 may require more memory to be dedicated to support functionality
958 When operating as an access point, pass packets between
959 wireless clients directly (default).
960 To instead let them pass up through the
961 system and be forwarded using some other mechanism, use
963 Disabling the internal bridging
964 is useful when traffic is to be processed with
966 .It Cm authmode Ar mode
967 Set the desired authentication mode in infrastructure mode.
968 Not all adapters support all modes.
971 .Cm none , open , shared
977 (IEEE WPA/WPA2/802.11i).
982 modes are only useful when using an authentication service
983 (a supplicant for client operation or an authenticator when
984 operating as an access point).
985 Modes are case insensitive.
987 Enable background scanning when operating as a station.
988 Background scanning is a technique whereby a station associated to
989 an access point will temporarily leave the channel to scan for
990 neighboring stations.
991 This allows a station to maintain a cache of nearby access points
992 so that roaming between access points can be done without
993 a lengthy scan operation.
994 Background scanning is done only when a station is not busy and
995 any outbound traffic will cancel a scan operation.
996 Background scanning should never cause packets to be lost though
997 there may be some small latency if outbound traffic interrupts a
999 By default background scanning is enabled if the device is capable.
1000 To disable background scanning, use
1002 Background scanning is controlled by the
1007 Background scanning must be enabled for roaming; this is an artifact
1008 of the current implementation and may not be required in the future.
1009 .It Cm bgscanidle Ar idletime
1010 Set the minimum time a station must be idle (not transmitting or
1011 receiving frames) before a background scan is initiated.
1014 parameter is specified in milliseconds.
1015 By default a station must be idle at least 250 milliseconds before
1016 a background scan is initiated.
1017 The idle time may not be set to less than 100 milliseconds.
1018 .It Cm bgscanintvl Ar interval
1019 Set the interval at which background scanning is attempted.
1022 parameter is specified in seconds.
1023 By default a background scan is considered every 300 seconds (5 minutes).
1026 may not be set to less than 15 seconds.
1027 .It Cm bintval Ar interval
1028 Set the interval at which beacon frames are sent when operating in
1032 parameter is specified in TU's (1024 usecs).
1033 By default beacon frames are transmitted every 100 TU's.
1034 .It Cm bmissthreshold Ar count
1035 Set the number of consecutive missed beacons at which the station
1036 will attempt to roam (i.e., search for a new access point).
1039 parameter must be in the range 1 to 255; though the
1040 upper bound may be reduced according to device capabilities.
1041 The default threshold is 7 consecutive missed beacons; but
1042 this may be overridden by the device driver.
1043 Another name for the
1047 .It Cm bssid Ar address
1048 Specify the MAC address of the access point to use when operating
1049 as a station in a BSS network.
1050 This overrides any automatic selection done by the system.
1051 To disable a previously selected access point, supply
1056 This option is useful when more than one access point uses the same SSID.
1057 Another name for the
1062 Enable packet bursting.
1063 Packet bursting is a transmission technique whereby the wireless
1064 medium is acquired once to send multiple frames and the interframe
1066 This technique can significantly increase throughput by reducing
1067 transmission overhead.
1068 Packet bursting is supported by the 802.11e QoS specification
1069 and some devices that do not support QoS may still be capable.
1070 By default packet bursting is enabled if a device is capable
1072 To disable packet bursting, use
1074 .It Cm chanlist Ar channels
1075 Set the desired channels to use when scanning for access
1076 points, neighbors in an IBSS network, or looking for unoccupied
1077 channels when operating as an access point.
1078 The set of channels is specified as a comma-separated list with
1079 each element in the list representing either a single channel number or a range
1082 Channel numbers must be in the range 1 to 255 and be permissible
1083 according to the operating characteristics of the device.
1084 .It Cm channel Ar number
1085 Set a single desired channel.
1086 Channels range from 1 to 255, but the exact selection available
1087 depends on the region your adaptor was manufactured for.
1093 will clear any desired channel and, if the device is marked up,
1094 force a scan for a channel to operate on.
1095 Alternatively the frequency, in megahertz, may be specified
1096 instead of the channel number.
1098 When there are several ways to use a channel the channel
1099 number/frequency may be appended with attributes to clarify.
1100 For example, if a device is capable of operating on channel 6
1101 with 802.11n and 802.11g then one can specify that g-only use
1102 should be used by specifying ``6:g''.
1103 Similarly the channel width can be specified by appending it
1104 with ``/''; e.g., ``6/40'' specifies a 40MHz wide channel,
1105 These attributes can be combined as in: ``6:ht/40''.
1106 The full set of flags specified following a ``:'' are:
1112 (Atheros Dynamic Turbo mode),
1120 (Atheros Static Turbo mode),
1123 (Atheros Dynamic Turbo mode, or appended to ``st'' and ``dt'').
1124 The full set of channel widths following a '/' are:
1126 (5MHz aka quarter-rate channel),
1128 (10MHz aka half-rate channel),
1130 (20MHz mostly for use in specifying ht20),
1133 (40MHz mostly for use in specifying ht40).
1135 a 40MHz HT channel specification may include the location
1136 of the extension channel by appending ``+'' or ``-'' for above and below,
1137 respectively; e.g., ``2437:ht/40+'' specifies 40MHz wide HT operation
1138 with the center channel at frequency 2437 and the extension channel above.
1139 .It Cm country Ar name
1140 Set the country code to use in calculating the regulatory constraints
1142 In particular the set of available channels, how the wireless device
1143 will operation on the channels, and the maximum transmit power that
1144 can be used on a channel are defined by this setting.
1145 Country/Region codes are specified as a 2-character abbreviation
1146 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1147 e.g., "ES" and "Spain".
1148 The set of country codes are taken from
1149 .Pa /etc/regdomain.xml
1151 be viewed with the ``list countries'' request.
1152 Note that not all devices support changing the country code from a default
1153 setting; typically stored in EEPROM.
1161 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1162 DFS embodies several facilities including detection of overlapping
1163 radar signals, dynamic transmit power control, and channel selection
1164 according to a least-congested criteria.
1165 DFS support is mandatory for some 5GHz frequencies in certain
1166 locales (e.g., ETSI).
1167 By default DFS is enabled according to the regulatory definitions
1169 .Pa /etc/regdomain.xml
1170 and the current country code, regdomain,
1172 Note the underlying device (and driver) must support radar detection
1173 for full DFS support to work.
1174 To be fully compliant with the local regulatory agency frequencies that
1175 require DFS should not be used unless it is fully supported.
1178 to disable this functionality for testing.
1180 Enable support for the 802.11d specification (default).
1181 When this support is enabled in station mode, beacon frames that advertise
1182 a country code different than the currently configured country code will
1183 cause an event to be dispatched to user applications.
1184 This event can be used by the station to adopt that country code and
1185 operate according to the associated regulatory constraints.
1186 When operating as an access point with 802.11d enabled the beacon and
1187 probe response frames transmitted will advertise the current regulatory
1189 To disable 802.11d use
1192 Enable 802.11h support including spectrum management.
1193 When 802.11h is enabled beacon and probe response frames will have
1194 the SpectrumMgt bit set in the capabilities field and
1195 country and power constraint information elements will be present.
1196 802.11h support also includes handling Channel Switch Announcements (CSA)
1197 which are a mechanism to coordinate channel changes by an access point.
1198 By default 802.11h is enabled if the device is capable.
1199 To disable 802.11h use
1201 .It Cm deftxkey Ar index
1202 Set the default key to use for transmission.
1203 Typically this is only set when using WEP encryption.
1204 Note that you must set a default transmit key
1205 for the system to know which key to use in encrypting outbound traffic.
1208 is an alias for this request; it is provided for backwards compatibility.
1209 .It Cm dtimperiod Ar period
1212 period for transmitting buffered multicast data frames when
1213 operating in ap mode.
1216 specifies the number of beacon intervals between DTIM
1217 and must be in the range 1 to 15.
1218 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1220 Enable the use of quiet IE.
1221 Hostap will use this to silence other
1222 stations to reduce interference for radar detection when
1223 operating on 5GHz frequency and doth support is enabled.
1226 to disable this functionality.
1227 .It Cm quiet_period Ar period
1230 to the number of beacon intervals between the start of regularly
1231 scheduled quiet intervals defined by Quiet element.
1232 .It Cm quiet_count Ar count
1235 to the number of TBTTs until the beacon interval during which the
1236 next quiet interval shall start.
1237 A value of 1 indicates the quiet
1238 interval will start during the beacon interval starting at the next
1240 A value 0 is reserved.
1241 .It Cm quiet_offset Ar offset
1244 to the offset of the start of the quiet interval from the TBTT
1245 specified by the Quiet count, expressed in TUs.
1248 shall be less than one beacon interval.
1249 .It Cm quiet_duration Ar dur
1252 to the duration of the Quiet interval, expressed in TUs.
1253 The value should be less than beacon interval.
1255 Enable the use of Atheros Dynamic Turbo mode when communicating with
1256 another Dynamic Turbo-capable station.
1257 Dynamic Turbo mode is an Atheros-specific mechanism by which
1258 stations switch between normal 802.11 operation and a ``boosted''
1259 mode in which a 40MHz wide channel is used for communication.
1260 Stations using Dynamic Turbo mode operate boosted only when the
1261 channel is free of non-dturbo stations; when a non-dturbo station
1262 is identified on the channel all stations will automatically drop
1263 back to normal operation.
1264 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1265 Note that turbo mode (dynamic or static) is only allowed on some
1266 channels depending on the regulatory constraints; use the
1268 command to identify the channels where turbo mode may be used.
1269 To disable Dynamic Turbo mode use
1272 Enable Dynamic WDS (DWDS) support.
1273 DWDS is a facility by which 4-address traffic can be carried between
1274 stations operating in infrastructure mode.
1275 A station first associates to an access point and authenticates using
1276 normal procedures (e.g., WPA).
1277 Then 4-address frames are passed to carry traffic for stations
1278 operating on either side of the wireless link.
1279 DWDS extends the normal WDS mechanism by leveraging existing security
1280 protocols and eliminating static binding.
1282 When DWDS is enabled on an access point 4-address frames received from
1283 an authorized station will generate a ``DWDS discovery'' event to user
1285 This event should be used to create a WDS interface that is bound
1286 to the remote station (and usually plumbed into a bridge).
1287 Once the WDS interface is up and running 4-address traffic then logically
1288 flows through that interface.
1290 When DWDS is enabled on a station, traffic with a destination address
1291 different from the peer station are encapsulated in a 4-address frame
1292 and transmitted to the peer.
1293 All 4-address traffic uses the security information of the stations
1294 (e.g., cryptographic keys).
1295 A station is associated using 802.11n facilities may transport
1296 4-address traffic using these same mechanisms; this depends on available
1297 resources and capabilities of the device.
1298 The DWDS implementation guards against layer 2 routing loops of
1301 Enable the use of Atheros Fast Frames when communicating with
1302 another Fast Frames-capable station.
1303 Fast Frames are an encapsulation technique by which two 802.3
1304 frames are transmitted in a single 802.11 frame.
1305 This can noticeably improve throughput but requires that the
1306 receiving station understand how to decapsulate the frame.
1307 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1308 protocol extension so enabling use is safe when communicating with
1309 non-Atheros devices.
1310 By default, use of fast frames is enabled if the device is capable.
1311 To explicitly disable fast frames, use
1313 .It Cm fragthreshold Ar length
1314 Set the threshold for which transmitted frames are broken into fragments.
1317 argument is the frame size in bytes and must be in the range 256 to 2346.
1325 disables transmit fragmentation.
1326 Not all adapters honor the fragmentation threshold.
1328 When operating as an access point, do not broadcast the SSID
1329 in beacon frames or respond to probe request frames unless
1330 they are directed to the ap (i.e., they include the ap's SSID).
1331 By default, the SSID is included in beacon frames and
1332 undirected probe request frames are answered.
1333 To re-enable the broadcast of the SSID etc., use
1336 Enable use of High Throughput (HT) when using 802.11n (default).
1337 The 802.11n specification includes mechanisms for operation
1338 on 20MHz and 40MHz wide channels using different signalling mechanisms
1339 than specified in 802.11b, 802.11g, and 802.11a.
1340 Stations negotiate use of these facilities, termed HT20 and HT40,
1341 when they associate.
1342 To disable all use of 802.11n use
1344 To disable use of HT20 (e.g., to force only HT40 use) use
1346 To disable use of HT40 use
1349 HT configuration is used to ``auto promote'' operation
1350 when several choices are available.
1351 For example, if a station associates to an 11n-capable access point
1352 it controls whether the station uses legacy operation, HT20, or HT40.
1353 When an 11n-capable device is setup as an access point and
1354 Auto Channel Selection is used to locate a channel to operate on,
1355 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1356 on the selected channel.
1357 If a fixed channel is specified for a station then HT configuration can
1358 be given as part of the channel specification; e.g., 6:ht/20 to setup
1359 HT20 operation on channel 6.
1361 Enable use of compatibility support for pre-802.11n devices (default).
1362 The 802.11n protocol specification went through several incompatible iterations.
1363 Some vendors implemented 11n support to older specifications that
1364 will not interoperate with a purely 11n-compliant station.
1365 In particular the information elements included in management frames
1366 for old devices are different.
1367 When compatibility support is enabled both standard and compatible data
1369 Stations that associate using the compatibility mechanisms are flagged
1371 To disable compatibility support use
1373 .It Cm htprotmode Ar technique
1374 For interfaces operating in 802.11n, use the specified
1376 for protecting HT frames in a mixed legacy/HT network.
1377 The set of valid techniques is
1382 Technique names are case insensitive.
1384 Enable inactivity processing for stations associated to an
1385 access point (default).
1386 When operating as an access point the 802.11 layer monitors
1387 the activity of each associated station.
1388 When a station is inactive for 5 minutes it will send several
1389 ``probe frames'' to see if the station is still present.
1390 If no response is received then the station is deauthenticated.
1391 Applications that prefer to handle this work can disable this
1395 Set the location to use in calculating regulatory constraints.
1396 The location is also advertised in beacon and probe response frames
1397 when 802.11d is enabled with
1406 Display the list of channels available for use taking into account
1407 any restrictions set with the
1410 See the description of
1412 for more information.
1414 Display the adaptor's capabilities, including the operating
1417 Display the list of channels available for use.
1418 Channels are shown with their IEEE channel number, equivalent
1419 frequency, and usage modes.
1420 Channels identified as
1425 Channels identified as
1427 may be used only for Atheros' Static Turbo mode
1429 . Cm mediaopt turbo ) .
1430 Channels marked with a
1432 have a regulatory constraint that they be passively scanned.
1433 This means a station is not permitted to transmit on the channel until
1434 it identifies the channel is being used for 802.11 communication;
1435 typically by hearing a beacon frame from an access point operating
1438 is another way of requesting this information.
1439 By default a compacted list of channels is displayed; if the
1441 option is specified then all channels are shown.
1442 .It Cm list countries
1443 Display the set of country codes and regulatory domains that can be
1444 used in regulatory configuration.
1446 Display the current MAC Access Control List state.
1447 Each address is prefixed with a character that indicates the
1448 current policy applied to it:
1450 indicates the address is allowed access,
1452 indicates the address is denied access,
1454 indicates the address is present but the current policy open
1455 (so the ACL is not consulted).
1457 Displays the mesh routing table, used for forwarding packets on a mesh
1459 .It Cm list regdomain
1460 Display the current regulatory settings including the available channels
1461 and transmit power caps.
1463 Display the parameters that govern roaming operation.
1465 Display the parameters that govern transmit operation.
1467 Display the transmit power caps for each channel.
1469 Display the access points and/or ad-hoc neighbors
1470 located in the vicinity.
1471 This information may be updated automatically by the adapter
1474 request or through background scanning.
1475 Depending on the capabilities of the stations the following
1476 flags can be included in the output:
1480 Indicates that the station is permitted to send/receive data frames.
1482 Extended Rate Phy (ERP).
1483 Indicates that the station is operating in an 802.11g network
1484 using extended transmit rates.
1486 High Throughput (HT).
1487 Indicates that the station is using HT transmit rates.
1488 If a `+' follows immediately after then the station associated
1489 using deprecated mechanisms supported only when
1494 Indicates that the station is operating in power save mode.
1496 Quality of Service (QoS).
1497 Indicates that the station is using QoS encapsulation for
1499 QoS encapsulation is enabled only when WME mode is enabled.
1502 Indicates that the station is doing short preamble to optionally
1503 improve throughput performance with 802.11g and 802.11b.
1505 Transitional Security Network (TSN).
1506 Indicates that the station associated using TSN; see also
1510 Wi-Fi Protected Setup (WPS).
1511 Indicates that the station associated using WPS.
1514 By default interesting information elements captured from the neighboring
1515 stations are displayed at the end of each row.
1516 Possible elements include:
1518 (station supports WME),
1520 (station supports WPA),
1522 (station supports WPS),
1524 (station supports 802.11i/RSN),
1526 (station supports 802.11n/HT communication),
1528 (station supports Atheros protocol extensions),
1530 (station supports unknown vendor-specific extensions).
1533 flag is used all the information elements and their
1534 contents will be shown.
1537 flag also enables display of long SSIDs.
1540 command is another way of requesting this information.
1542 When operating as an access point display the stations that are
1543 currently associated.
1544 When operating in ad-hoc mode display stations identified as
1545 neighbors in the IBSS.
1546 When operating in mesh mode display stations identified as
1547 neighbors in the MBSS.
1548 When operating in station mode display the access point.
1549 Capabilities advertised by the stations are described under
1553 Depending on the capabilities of the stations the following
1554 flags can be included in the output:
1558 Indicates that the station is permitted to send/receive data frames.
1560 Extended Rate Phy (ERP).
1561 Indicates that the station is operating in an 802.11g network
1562 using extended transmit rates.
1564 High Throughput (HT).
1565 Indicates that the station is using HT transmit rates.
1566 If a `+' follows immediately after then the station associated
1567 using deprecated mechanisms supported only when
1572 Indicates that the station is operating in power save mode.
1574 Quality of Service (QoS).
1575 Indicates that the station is using QoS encapsulation for
1577 QoS encapsulation is enabled only when WME mode is enabled.
1580 Indicates that the station is doing short preamble to optionally
1581 improve throughput performance with 802.11g and 802.11b.
1583 Transitional Security Network (TSN).
1584 Indicates that the station associated using TSN; see also
1588 Wi-Fi Protected Setup (WPS).
1589 Indicates that the station associated using WPS.
1592 By default information elements received from associated stations
1593 are displayed in a short form; the
1595 flag causes this information to be displayed symbolically.
1597 Display the current channel parameters to use when operating in WME mode.
1600 option is specified then both channel and BSS parameters are displayed
1601 for each AC (first channel, then BSS).
1602 When WME mode is enabled for an adaptor this information will be
1603 displayed with the regular status; this command is mostly useful
1604 for examining parameters when WME mode is disabled.
1605 See the description of the
1607 directive for information on the various parameters.
1608 .It Cm maxretry Ar count
1609 Set the maximum number of tries to use in sending unicast frames.
1610 The default setting is 6 but drivers may override this with a value
1612 .It Cm mcastrate Ar rate
1613 Set the rate for transmitting multicast/broadcast frames.
1614 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1615 This rate should be valid for the current operating conditions;
1616 if an invalid rate is specified drivers are free to chose an
1618 .It Cm mgtrate Ar rate
1619 Set the rate for transmitting management and/or control frames.
1620 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1622 Set the location to use in calculating regulatory constraints.
1623 The location is also advertised in beacon and probe response frames
1624 when 802.11d is enabled with
1633 Enable powersave operation.
1634 When operating as a client, the station will conserve power by
1635 periodically turning off the radio and listening for
1636 messages from the access point telling it there are packets waiting.
1637 The station must then retrieve the packets.
1638 Not all devices support power save operation as a client.
1639 The 802.11 specification requires that all access points support
1640 power save but some drivers do not.
1643 to disable powersave operation when operating as a client.
1644 .It Cm powersavesleep Ar sleep
1645 Set the desired max powersave sleep time in TU's (1024 usecs).
1646 By default the max powersave sleep time is 100 TU's.
1647 .It Cm protmode Ar technique
1648 For interfaces operating in 802.11g, use the specified
1650 for protecting OFDM frames in a mixed 11b/11g network.
1651 The set of valid techniques is
1657 Technique names are case insensitive.
1658 Not all devices support
1660 as a protection technique.
1662 When operating as an access point in 802.11g mode allow only
1663 11g-capable stations to associate (11b-only stations are not
1664 permitted to associate).
1665 To allow both 11g and 11b-only stations to associate, use
1668 When operating as an access point in 802.11n mode allow only
1669 HT-capable stations to associate (legacy stations are not
1670 permitted to associate).
1671 To allow both HT and legacy stations to associate, use
1673 .It Cm regdomain Ar sku
1674 Set the regulatory domain to use in calculating the regulatory constraints
1676 In particular the set of available channels, how the wireless device
1677 will operation on the channels, and the maximum transmit power that
1678 can be used on a channel are defined by this setting.
1679 Regdomain codes (SKU's) are taken from
1680 .Pa /etc/regdomain.xml
1682 be viewed with the ``list countries'' request.
1683 Note that not all devices support changing the regdomain from a default
1684 setting; typically stored in EEPROM.
1692 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1694 Note that RIFS must be supported by both the station and access point
1698 .It Cm roam:rate Ar rate
1699 Set the threshold for controlling roaming when operating in a BSS.
1702 parameter specifies the transmit rate in megabits
1703 at which roaming should be considered.
1704 If the current transmit rate drops below this setting and background scanning
1705 is enabled, then the system will check if a more desirable access point is
1706 available and switch over to it.
1707 The current scan cache contents are used if they are considered
1708 valid according to the
1710 parameter; otherwise a background scan operation is triggered before
1711 any selection occurs.
1712 Each channel type has a separate rate threshold; the default values are:
1713 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1714 .It Cm roam:rssi Ar rssi
1715 Set the threshold for controlling roaming when operating in a BSS.
1718 parameter specifies the receive signal strength in dBm units
1719 at which roaming should be considered.
1720 If the current rssi drops below this setting and background scanning
1721 is enabled, then the system will check if a more desirable access point is
1722 available and switch over to it.
1723 The current scan cache contents are used if they are considered
1724 valid according to the
1726 parameter; otherwise a background scan operation is triggered before
1727 any selection occurs.
1728 Each channel type has a separate rssi threshold; the default values are
1730 .It Cm roaming Ar mode
1731 When operating as a station, control how the system will
1732 behave when communication with the current access point
1736 argument may be one of
1738 (leave it to the hardware device to decide),
1740 (handle either in the device or the operating system\[em]as appropriate),
1742 (do nothing until explicitly instructed).
1743 By default, the device is left to handle this if it is
1744 capable; otherwise, the operating system will automatically
1745 attempt to reestablish communication.
1746 Manual mode is used by applications such as
1747 .Xr wpa_supplicant 8
1748 that want to control the selection of an access point.
1749 .It Cm rtsthreshold Ar length
1750 Set the threshold for which
1751 transmitted frames are preceded by transmission of an
1757 is the frame size in bytes and must be in the range 1 to 2346.
1765 disables transmission of RTS frames.
1766 Not all adapters support setting the RTS threshold.
1768 Initiate a scan of neighboring stations, wait for it to complete, and
1769 display all stations found.
1770 Only the super-user can initiate a scan.
1773 for information on the display.
1774 By default a background scan is done; otherwise a foreground
1775 scan is done and the station may roam to a different access point.
1778 request can be used to show recent scan results without
1779 initiating a new scan.
1780 .It Cm scanvalid Ar threshold
1781 Set the maximum time the scan cache contents are considered valid;
1782 i.e., will be used without first triggering a scan operation to
1786 parameter is specified in seconds and defaults to 60 seconds.
1787 The minimum setting for
1790 One should take care setting this threshold; if it is set too low
1791 then attempts to roam to another access point may trigger unnecessary
1792 background scan operations.
1794 Enable use of Short Guard Interval when operating in 802.11n
1796 NB: this currently enables Short GI on both HT40 and HT20 channels.
1797 To disable Short GI use
1800 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1801 when operating in 802.11n.
1802 A station operating with Static SMPS maintains only a single
1803 receive chain active (this can significantly reduce power consumption).
1807 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1808 when operating in 802.11n.
1809 A station operating with Dynamic SMPS maintains only a single
1810 receive chain active but switches to multiple receive chains when it
1811 receives an RTS frame (this can significantly reduce power consumption).
1812 Note that stations cannot distinguish between RTS/CTS intended to
1813 enable multiple receive chains and those used for other purposes.
1817 Set the desired Service Set Identifier (aka network name).
1818 The SSID is a string up to 32 characters
1819 in length and may be specified as either a normal string or in
1820 hexadecimal when preceded by
1822 Additionally, the SSID may be cleared by setting it to
1824 .It Cm tdmaslot Ar slot
1825 When operating with TDMA, use the specified
1830 is a number between 0 and the maximum number of slots in the BSS.
1831 Note that a station configured as slot 0 is a master and
1832 will broadcast beacon frames advertising the BSS;
1833 stations configured to use other slots will always
1834 scan to locate a master before they ever transmit.
1838 .It Cm tdmaslotcnt Ar cnt
1839 When operating with TDMA, setup a BSS with
1842 The slot count may be at most 8.
1843 The current implementation is only tested with two stations
1844 (i.e., point to point applications).
1845 This setting is only meaningful when a station is configured as slot 0;
1846 other stations adopt this setting from the BSS they join.
1850 .It Cm tdmaslotlen Ar len
1851 When operating with TDMA, setup a BSS such that each station has a slot
1854 The slot length must be at least 150 microseconds (1/8 TU)
1855 and no more than 65 milliseconds.
1856 Note that setting too small a slot length may result in poor channel
1857 bandwidth utilization due to factors such as timer granularity and
1859 This setting is only meaningful when a station is configured as slot 0;
1860 other stations adopt this setting from the BSS they join.
1863 is set to 10 milliseconds.
1864 .It Cm tdmabintval Ar intval
1865 When operating with TDMA, setup a BSS such that beacons are transmitted every
1867 superframes to synchronize the TDMA slot timing.
1868 A superframe is defined as the number of slots times the slot length; e.g.,
1869 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
1870 The beacon interval may not be zero.
1873 causes the timers to be resynchronized more often; this can be help if
1874 significant timer drift is observed.
1879 When operating as an access point with WPA/802.11i allow legacy
1880 stations to associate using static key WEP and open authentication.
1881 To disallow legacy station use of WEP, use
1883 .It Cm txpower Ar power
1884 Set the power used to transmit frames.
1887 argument is specified in .5 dBm units.
1888 Out of range values are truncated.
1889 Typically only a few discreet power settings are available and
1890 the driver will use the setting closest to the specified value.
1891 Not all adapters support changing the transmit power.
1892 .It Cm ucastrate Ar rate
1893 Set a fixed rate for transmitting unicast frames.
1894 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1895 This rate should be valid for the current operating conditions;
1896 if an invalid rate is specified drivers are free to chose an
1898 .It Cm wepmode Ar mode
1899 Set the desired WEP mode.
1900 Not all adapters support all modes.
1901 The set of valid modes is
1907 mode explicitly tells the adaptor to allow association with access
1908 points which allow both encrypted and unencrypted traffic.
1911 means that the access point must only allow encrypted connections.
1914 is generally another name for
1916 Modes are case insensitive.
1917 .It Cm weptxkey Ar index
1918 Set the WEP key to be used for transmission.
1919 This is the same as setting the default transmission key with
1921 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
1922 Set the selected WEP key.
1925 is not given, key 1 is set.
1926 A WEP key will be either 5 or 13
1927 characters (40 or 104 bits) depending on the local network and the
1928 capabilities of the adaptor.
1929 It may be specified either as a plain
1930 string or as a string of hexadecimal digits preceded by
1932 For maximum portability, hex keys are recommended;
1933 the mapping of text keys to WEP encryption is usually driver-specific.
1936 drivers do this mapping differently to
1938 A key may be cleared by setting it to
1940 If WEP is supported then there are at least four keys.
1941 Some adapters support more than four keys.
1942 If that is the case, then the first four keys
1943 (1-4) will be the standard temporary keys and any others will be adaptor
1944 specific keys such as permanent keys stored in NVRAM.
1946 Note that you must set a default transmit key with
1948 for the system to know which key to use in encrypting outbound traffic.
1950 Enable Wireless Multimedia Extensions (WME) support, if available,
1951 for the specified interface.
1952 WME is a subset of the IEEE 802.11e standard to support the
1953 efficient communication of realtime and multimedia data.
1954 To disable WME support, use
1956 Another name for this parameter is
1959 The following parameters are meaningful only when WME support is in use.
1960 Parameters are specified per-AC (Access Category) and
1961 split into those that are used by a station when acting
1962 as an access point and those for client stations in the BSS.
1963 The latter are received from the access point and may not be changed
1965 The following Access Categories are recognized:
1967 .Bl -tag -width ".Cm AC_BK" -compact
1971 best effort delivery,
1986 AC parameters are case-insensitive.
1987 Traffic classification is done in the operating system using the
1988 vlan priority associated with data frames or the
1989 ToS (Type of Service) indication in IP-encapsulated frames.
1990 If neither information is present, traffic is assigned to the
1991 Best Effort (BE) category.
1992 .Bl -tag -width indent
1994 Set the ACK policy for QoS transmissions by the local station;
1995 this controls whether or not data frames transmitted by a station
1996 require an ACK response from the receiving station.
1997 To disable waiting for an ACK use
1999 This parameter is applied only to the local station.
2001 Enable the Admission Control Mandatory (ACM) mechanism
2002 for transmissions by the local station.
2003 To disable the ACM use
2005 On stations in a BSS this parameter is read-only and indicates
2006 the setting received from the access point.
2007 NB: ACM is not supported right now.
2008 .It Cm aifs Ar ac Ar count
2009 Set the Arbitration Inter Frame Spacing (AIFS)
2010 channel access parameter to use for transmissions
2011 by the local station.
2012 On stations in a BSS this parameter is read-only and indicates
2013 the setting received from the access point.
2014 .It Cm cwmin Ar ac Ar count
2015 Set the CWmin channel access parameter to use for transmissions
2016 by the local station.
2017 On stations in a BSS this parameter is read-only and indicates
2018 the setting received from the access point.
2019 .It Cm cwmax Ar ac Ar count
2020 Set the CWmax channel access parameter to use for transmissions
2021 by the local station.
2022 On stations in a BSS this parameter is read-only and indicates
2023 the setting received from the access point.
2024 .It Cm txoplimit Ar ac Ar limit
2025 Set the Transmission Opportunity Limit channel access parameter
2026 to use for transmissions by the local station.
2027 This parameter defines an interval of time when a WME station
2028 has the right to initiate transmissions onto the wireless medium.
2029 On stations in a BSS this parameter is read-only and indicates
2030 the setting received from the access point.
2031 .It Cm bss:aifs Ar ac Ar count
2032 Set the AIFS channel access parameter to send to stations in a BSS.
2033 This parameter is meaningful only when operating in ap mode.
2034 .It Cm bss:cwmin Ar ac Ar count
2035 Set the CWmin channel access parameter to send to stations in a BSS.
2036 This parameter is meaningful only when operating in ap mode.
2037 .It Cm bss:cwmax Ar ac Ar count
2038 Set the CWmax channel access parameter to send to stations in a BSS.
2039 This parameter is meaningful only when operating in ap mode.
2040 .It Cm bss:txoplimit Ar ac Ar limit
2041 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2042 This parameter is meaningful only when operating in ap mode.
2045 Enable Wireless Privacy Subscriber support.
2046 Note that WPS support requires a WPS-capable supplicant.
2047 To disable this function use
2051 The following parameters support an optional access control list
2052 feature available with some adapters when operating in ap mode; see
2054 This facility allows an access point to accept/deny association
2055 requests based on the MAC address of the station.
2056 Note that this feature does not significantly enhance security
2057 as MAC address spoofing is easy to do.
2058 .Bl -tag -width indent
2059 .It Cm mac:add Ar address
2060 Add the specified MAC address to the database.
2061 Depending on the policy setting association requests from the
2062 specified station will be allowed or denied.
2064 Set the ACL policy to permit association only by
2065 stations registered in the database.
2066 .It Cm mac:del Ar address
2067 Delete the specified MAC address from the database.
2069 Set the ACL policy to deny association only by
2070 stations registered in the database.
2071 .It Cm mac:kick Ar address
2072 Force the specified station to be deauthenticated.
2073 This typically is done to block a station after updating the
2076 Set the ACL policy to allow all stations to associate.
2078 Delete all entries in the database.
2080 Set the ACL policy to permit association only by
2081 stations approved by a RADIUS server.
2082 Note that this feature requires the
2084 program be configured to do the right thing
2085 as it handles the RADIUS processing
2086 (and marks stations as authorized).
2089 The following parameters are related to a wireless interface operating in mesh
2091 .Bl -tag -width indent
2092 .It Cm meshid Ar meshid
2093 Set the desired Mesh Identifier.
2094 The Mesh ID is a string up to 32 characters in length.
2095 A mesh interface must have a Mesh Identifier specified
2096 to reach an operational state.
2097 .It Cm meshttl Ar ttl
2098 Set the desired ``time to live'' for mesh forwarded packets;
2099 this is the number of hops a packet may be forwarded before
2101 The default setting for
2105 Enable or disable peering with neighbor mesh stations.
2106 Stations must peer before any data packets can be exchanged.
2111 Enable or disable forwarding packets by a mesh interface.
2116 This attribute specifies whether or not the mesh STA activates mesh gate
2121 .It Cm meshmetric Ar protocol
2124 as the link metric protocol used on a mesh network.
2125 The default protocol is called
2127 The mesh interface will restart after changing this setting.
2128 .It Cm meshpath Ar protocol
2131 as the path selection protocol used on a mesh network.
2132 The only available protocol at the moment is called
2134 (Hybrid Wireless Mesh Protocol).
2135 The mesh interface will restart after changing this setting.
2136 .It Cm hwmprootmode Ar mode
2137 Stations on a mesh network can operate as ``root nodes.''
2138 Root nodes try to find paths to all mesh nodes and advertise themselves
2140 When there is a root mesh node on a network, other mesh nodes can setup
2141 paths between themselves faster because they can use the root node
2142 to find the destination.
2143 This path may not be the best, but on-demand
2144 routing will eventually find the best path.
2145 The following modes are recognized:
2147 .Bl -tag -width ".Cm PROACTIVE" -compact
2151 Send broadcast path requests every two seconds.
2152 Nodes on the mesh without a path to this root mesh station with try to
2153 discover a path to us.
2155 Send broadcast path requests every two seconds and every node must reply
2156 with a path reply even if it already has a path to this root mesh station.
2158 Send broadcast root announcement (RANN) frames.
2159 Nodes on the mesh without a path to this root mesh station with try to
2160 discover a path to us.
2166 .It Cm hwmpmaxhops Ar cnt
2167 Set the maximum number of hops allowed in an HMWP path to
2169 The default setting for
2174 The following parameters are for compatibility with other systems:
2175 .Bl -tag -width indent
2177 Another name for the
2183 .It Cm stationname Ar name
2184 Set the name of this station.
2185 The station name is not part of the IEEE 802.11
2186 protocol though some interfaces support it.
2188 seems to be meaningful to identical or virtually identical equipment.
2189 Setting the station name is identical in syntax to setting the SSID.
2196 Another way of saying
2202 Another way of saying
2208 Another way of saying:
2209 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2215 .Ar n : k1 , k2 , k3 , k4
2218 Another way of saying
2219 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2224 Another way of saying
2231 The following parameters are specific to bridge interfaces:
2232 .Bl -tag -width indent
2233 .It Cm addm Ar interface
2234 Add the interface named by
2236 as a member of the bridge.
2237 The interface is put into promiscuous mode
2238 so that it can receive every packet sent on the network.
2239 .It Cm deletem Ar interface
2240 Remove the interface named by
2243 Promiscuous mode is disabled on the interface when
2244 it is removed from the bridge.
2245 .It Cm maxaddr Ar size
2246 Set the size of the bridge address cache to
2248 The default is 2000 entries.
2249 .It Cm timeout Ar seconds
2250 Set the timeout of address cache entries to
2255 is zero, then address cache entries will not be expired.
2256 The default is 1200 seconds.
2258 Display the addresses that have been learned by the bridge.
2259 .It Cm static Ar interface-name Ar address
2260 Add a static entry into the address cache pointing to
2261 .Ar interface-name .
2262 Static entries are never aged out of the cache or re-placed, even if the
2263 address is seen on a different interface.
2264 .It Cm deladdr Ar address
2267 from the address cache.
2269 Delete all dynamically-learned addresses from the address cache.
2271 Delete all addresses, including static addresses, from the address cache.
2272 .It Cm discover Ar interface
2273 Mark an interface as a
2276 When the bridge has no address cache entry
2277 (either dynamic or static)
2278 for the destination address of a packet,
2279 the bridge will forward the packet to all
2280 member interfaces marked as
2282 This is the default for all interfaces added to a bridge.
2283 .It Cm -discover Ar interface
2286 attribute on a member interface.
2287 For packets without the
2289 attribute, the only packets forwarded on the interface are broadcast
2290 or multicast packets and packets for which the destination address
2291 is known to be on the interface's segment.
2292 .It Cm learn Ar interface
2293 Mark an interface as a
2296 When a packet arrives on such an interface, the source
2297 address of the packet is entered into the address cache as being a
2298 destination address on the interface's segment.
2299 This is the default for all interfaces added to a bridge.
2300 .It Cm -learn Ar interface
2303 attribute on a member interface.
2304 .It Cm sticky Ar interface
2305 Mark an interface as a
2308 Dynamically learned address entries are treated at static once entered into
2310 Sticky entries are never aged out of the cache or replaced, even if the
2311 address is seen on a different interface.
2312 .It Cm -sticky Ar interface
2315 attribute on a member interface.
2316 .It Cm private Ar interface
2317 Mark an interface as a
2320 A private interface does not forward any traffic to any other port that is also
2321 a private interface.
2322 .It Cm -private Ar interface
2325 attribute on a member interface.
2326 .It Cm span Ar interface
2327 Add the interface named by
2329 as a span port on the bridge.
2330 Span ports transmit a copy of every frame received by the bridge.
2331 This is most useful for snooping a bridged network passively on
2332 another host connected to one of the span ports of the bridge.
2333 .It Cm -span Ar interface
2334 Delete the interface named by
2336 from the list of span ports of the bridge.
2337 .It Cm stp Ar interface
2338 Enable Spanning Tree protocol on
2342 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2343 Spanning Tree is used to detect and remove loops in a network topology.
2344 .It Cm -stp Ar interface
2345 Disable Spanning Tree protocol on
2347 This is the default for all interfaces added to a bridge.
2348 .It Cm edge Ar interface
2352 An edge port connects directly to end stations cannot create bridging
2353 loops in the network, this allows it to transition straight to forwarding.
2354 .It Cm -edge Ar interface
2355 Disable edge status on
2357 .It Cm autoedge Ar interface
2360 to automatically detect edge status.
2361 This is the default for all interfaces added to a bridge.
2362 .It Cm -autoedge Ar interface
2363 Disable automatic edge status on
2365 .It Cm ptp Ar interface
2368 as a point to point link.
2369 This is required for straight transitions to forwarding and
2370 should be enabled on a direct link to another RSTP capable switch.
2371 .It Cm -ptp Ar interface
2372 Disable point to point link status on
2374 This should be disabled for a half duplex link and for an interface
2375 connected to a shared network segment,
2376 like a hub or a wireless network.
2377 .It Cm autoptp Ar interface
2378 Automatically detect the point to point status on
2380 by checking the full duplex link status.
2381 This is the default for interfaces added to the bridge.
2382 .It Cm -autoptp Ar interface
2383 Disable automatic point to point link detection on
2385 .It Cm maxage Ar seconds
2386 Set the time that a Spanning Tree protocol configuration is valid.
2387 The default is 20 seconds.
2388 The minimum is 6 seconds and the maximum is 40 seconds.
2389 .It Cm fwddelay Ar seconds
2390 Set the time that must pass before an interface begins forwarding
2391 packets when Spanning Tree is enabled.
2392 The default is 15 seconds.
2393 The minimum is 4 seconds and the maximum is 30 seconds.
2394 .It Cm hellotime Ar seconds
2395 Set the time between broadcasting of Spanning Tree protocol
2396 configuration messages.
2397 The hello time may only be changed when operating in legacy stp mode.
2398 The default is 2 seconds.
2399 The minimum is 1 second and the maximum is 2 seconds.
2400 .It Cm priority Ar value
2401 Set the bridge priority for Spanning Tree.
2402 The default is 32768.
2403 The minimum is 0 and the maximum is 61440.
2404 .It Cm proto Ar value
2405 Set the Spanning Tree protocol.
2406 The default is rstp.
2407 The available options are stp and rstp.
2408 .It Cm holdcnt Ar value
2409 Set the transmit hold count for Spanning Tree.
2410 This is the number of packets transmitted before being rate limited.
2412 The minimum is 1 and the maximum is 10.
2413 .It Cm ifpriority Ar interface Ar value
2414 Set the Spanning Tree priority of
2419 The minimum is 0 and the maximum is 240.
2420 .It Cm ifpathcost Ar interface Ar value
2421 Set the Spanning Tree path cost of
2425 The default is calculated from the link speed.
2426 To change a previously selected path cost back to automatic, set the
2428 The minimum is 1 and the maximum is 200000000.
2429 .It Cm ifmaxaddr Ar interface Ar size
2430 Set the maximum number of hosts allowed from an interface, packets with unknown
2431 source addresses are dropped until an existing host cache entry expires or is
2433 Set to 0 to disable.
2436 The following parameters are specific to lagg interfaces:
2437 .Bl -tag -width indent
2438 .It Cm laggport Ar interface
2439 Add the interface named by
2441 as a port of the aggregation interface.
2442 .It Cm -laggport Ar interface
2443 Remove the interface named by
2445 from the aggregation interface.
2446 .It Cm laggproto Ar proto
2447 Set the aggregation protocol.
2450 The available options are
2458 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2459 Set the packet layers to hash for aggregation protocols which load balance.
2462 The options can be combined using commas.
2464 .Bl -tag -width ".Cm l2" -compact
2466 src/dst mac address and optional vlan number.
2468 src/dst address for IPv4 or IPv6.
2470 src/dst port for TCP/UDP/SCTP.
2473 Enable local hash computation for RSS hash on the interface.
2478 modes will use the RSS hash from the network card if available
2479 to avoid computing one, this may give poor traffic distribution
2480 if the hash is invalid or uses less of the protocol header information.
2482 disables use of RSS hash from the network card.
2483 The default value can be set via the
2484 .Va net.link.lagg.default_use_flowid
2495 Use the RSS hash from the network card if available.
2496 .It Cm flowid_shift Ar number
2497 Set a shift parameter for RSS local hash computation.
2498 Hash is calculated by using flowid bits in a packet header mbuf
2499 which are shifted by the number of this parameter.
2501 Enable selection of egress ports based on the native
2503 domain for the packets being transmitted.
2504 This is currently only implemented for lacp mode.
2507 hardware, running a kernel compiled with the
2509 option, and when interfaces from multiple
2511 domains are ports of the aggregation interface.
2513 Disable selection of egress ports based on the native
2515 domain for the packets being transmitted.
2516 .It Cm lacp_fast_timeout
2517 Enable lacp fast-timeout on the interface.
2518 .It Cm -lacp_fast_timeout
2519 Disable lacp fast-timeout on the interface.
2521 Enable lacp strict compliance on the interface.
2522 The default value can be set via the
2523 .Va net.link.lagg.lacp.default_strict_mode
2534 Disable lacp strict compliance on the interface.
2537 The following parameters apply to IP tunnel interfaces,
2539 .Bl -tag -width indent
2540 .It Cm tunnel Ar src_addr dest_addr
2541 Configure the physical source and destination address for IP tunnel
2547 are interpreted as the outer source/destination for the encapsulating
2550 Unconfigure the physical source and destination address for IP tunnel
2551 interfaces previously configured with
2554 Another name for the
2557 .It Cm accept_rev_ethip_ver
2558 Set a flag to accept both correct EtherIP packets and ones
2559 with reversed version field.
2561 This is for backward compatibility with
2563 6.2, 6.3, 7.0, and 7.1.
2564 .It Cm -accept_rev_ethip_ver
2566 .Cm accept_rev_ethip_ver .
2567 .It Cm ignore_source
2568 Set a flag to accept encapsulated packets destined to this host
2569 independently from source address.
2570 This may be useful for hosts, that receive encapsulated packets
2571 from the load balancers.
2572 .It Cm -ignore_source
2575 .It Cm send_rev_ethip_ver
2576 Set a flag to send EtherIP packets with reversed version
2577 field intentionally.
2578 Disabled by default.
2579 This is for backward compatibility with
2581 6.2, 6.3, 7.0, and 7.1.
2582 .It Cm -send_rev_ethip_ver
2584 .Cm send_rev_ethip_ver .
2587 The following parameters apply to GRE tunnel interfaces,
2589 .Bl -tag -width indent
2590 .It Cm tunnel Ar src_addr dest_addr
2591 Configure the physical source and destination address for GRE tunnel
2597 are interpreted as the outer source/destination for the encapsulating
2600 Unconfigure the physical source and destination address for GRE tunnel
2601 interfaces previously configured with
2604 Another name for the
2607 .It Cm grekey Ar key
2608 Configure the GRE key to be used for outgoing packets.
2610 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2611 This command will result in a four byte MTU reduction on the interface.
2614 The following parameters are specific to
2617 .Bl -tag -width indent
2618 .It Cm syncdev Ar iface
2619 Use the specified interface
2620 to send and receive pfsync state synchronisation messages.
2622 Stop sending pfsync state synchronisation messages over the network.
2623 .It Cm syncpeer Ar peer_address
2624 Make the pfsync link point-to-point rather than using
2625 multicast to broadcast the state synchronisation messages.
2626 The peer_address is the IP address of the other host taking part in
2629 Broadcast the packets using multicast.
2631 Set the maximum number of updates for a single state which
2632 can be collapsed into one.
2633 This is an 8-bit number; the default value is 128.
2635 Defer transmission of the first packet in a state until a peer has
2636 acknowledged that the associated state has been inserted.
2638 Do not defer the first packet in a state.
2639 This is the default.
2642 The following parameters are specific to
2645 .Bl -tag -width indent
2646 .It Cm vlan Ar vlan_tag
2647 Set the VLAN tag value to
2649 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2650 VLAN header for packets sent from the
2657 must both be set at the same time.
2658 .It Cm vlanpcp Ar priority_code_point
2661 is an 3-bit field which refers to the IEEE 802.1p
2662 class of service and maps to the frame priority level.
2664 Values in order of priority are:
2666 .Pq Dv Background (lowest) ,
2668 .Pq Dv Best effort (default) ,
2670 .Pq Dv Excellent effort ,
2672 .Pq Dv Critical applications ,
2674 .Pq Dv Video, < 100ms latency ,
2676 .Pq Dv Video, < 10ms latency ,
2678 .Pq Dv Internetwork control ,
2680 .Pq Dv Network control (highest) .
2681 .It Cm vlandev Ar iface
2682 Associate the physical interface
2687 Packets transmitted through the
2690 diverted to the specified physical interface
2692 with 802.1Q VLAN encapsulation.
2693 Packets with 802.1Q encapsulation received
2694 by the parent interface with the correct VLAN Identifier will be diverted to
2700 interface is assigned a
2701 copy of the parent interface's flags and the parent's Ethernet address.
2706 must both be set at the same time.
2709 interface already has
2710 a physical interface associated with it, this command will fail.
2712 change the association to another physical interface, the existing
2713 association must be cleared first.
2715 Note: if the hardware tagging capability
2716 is set on the parent interface, the
2719 interface's behavior changes:
2722 interface recognizes that the
2723 parent interface supports insertion and extraction of VLAN tags on its
2724 own (usually in firmware) and that it should pass packets to and from
2725 the parent unaltered.
2726 .It Fl vlandev Op Ar iface
2729 pseudo device, disassociate the parent interface from it.
2730 This breaks the link between the
2732 interface and its parent,
2733 clears its VLAN Identifier, flags and its link address and shuts the interface
2737 argument is useless and hence deprecated.
2740 The following parameters are used to configure
2743 .Bl -tag -width indent
2744 .It Cm vxlanid Ar identifier
2745 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2746 virtual network segment membership of the interface.
2747 .It Cm vxlanlocal Ar address
2748 The source address used in the encapsulating IPv4/IPv6 header.
2749 The address should already be assigned to an existing interface.
2750 When the interface is configured in unicast mode, the listening socket
2751 is bound to this address.
2752 .It Cm vxlanremote Ar address
2753 The interface can be configured in a unicast, or point-to-point, mode
2754 to create a tunnel between two hosts.
2755 This is the IP address of the remote end of the tunnel.
2756 .It Cm vxlangroup Ar address
2757 The interface can be configured in a multicast mode
2758 to create a virtual network of hosts.
2759 This is the IP multicast group address the interface will join.
2760 .It Cm vxlanlocalport Ar port
2761 The port number the interface will listen on.
2762 The default port number is 4789.
2763 .It Cm vxlanremoteport Ar port
2764 The destination port number used in the encapsulating IPv4/IPv6 header.
2765 The remote host should be listening on this port.
2766 The default port number is 4789.
2767 Note some other implementations, such as Linux,
2768 do not default to the IANA assigned port,
2769 but instead listen on port 8472.
2770 .It Cm vxlanportrange Ar low high
2771 The range of source ports used in the encapsulating IPv4/IPv6 header.
2772 The port selected within the range is based on a hash of the inner frame.
2773 A range is useful to provide entropy within the outer IP header
2774 for more effective load balancing.
2775 The default range is between the
2778 .Va net.inet.ip.portrange.first
2780 .Va net.inet.ip.portrange.last
2781 .It Cm vxlantimeout Ar timeout
2782 The maximum time, in seconds, before an entry in the forwarding table
2784 The default is 1200 seconds (20 minutes).
2785 .It Cm vxlanmaxaddr Ar max
2786 The maximum number of entries in the forwarding table.
2787 The default is 2000.
2788 .It Cm vxlandev Ar dev
2789 When the interface is configured in multicast mode, the
2791 interface is used to transmit IP multicast packets.
2792 .It Cm vxlanttl Ar ttl
2793 The TTL used in the encapsulating IPv4/IPv6 header.
2796 The source IP address and inner source Ethernet MAC address of
2797 received packets are used to dynamically populate the forwarding table.
2798 When in multicast mode, an entry in the forwarding table allows the
2799 interface to send the frame directly to the remote host instead of
2800 broadcasting the frame to the multicast group.
2801 This is the default.
2803 The forwarding table is not populated by received packets.
2805 Delete all dynamically-learned addresses from the forwarding table.
2806 .It Cm vxlanflushall
2807 Delete all addresses, including static addresses, from the forwarding table.
2810 The following parameters are used to configure
2812 protocol on an interface:
2813 .Bl -tag -width indent
2815 Set the virtual host ID.
2816 This is a required setting to initiate
2818 If the virtual host ID does not exist yet, it is created and attached to the
2819 interface, otherwise configuration of an existing vhid is adjusted.
2822 keyword is supplied along with an
2826 address, then this address is configured to be run under control of the
2828 Whenever a last address that refers to a particular vhid is removed from an
2829 interface, the vhid is automatically removed from interface and destroyed.
2830 Any other configuration parameters for the
2832 protocol should be supplied along with the
2835 Acceptable values for vhid are 1 to 255.
2836 .It Cm advbase Ar seconds
2837 Specifies the base of the advertisement interval in seconds.
2838 The acceptable values are 1 to 255.
2839 The default value is 1.
2840 .It Cm advskew Ar interval
2841 Specifies the skew to add to the base advertisement interval to
2842 make one host advertise slower than another host.
2843 It is specified in 1/256 of seconds.
2844 The acceptable values are 1 to 254.
2845 The default value is 0.
2846 .It Cm pass Ar phrase
2847 Set the authentication key to
2849 .It Cm state Ar MASTER|BACKUP
2850 Forcibly change state of a given vhid.
2855 utility displays the current configuration for a network interface
2856 when no optional parameters are supplied.
2857 If a protocol family is specified,
2859 will report only the details specific to that protocol family.
2863 flag is passed before an interface name,
2865 will display the capability list and all
2866 of the supported media for the specified interface.
2869 flag is supplied, address lifetime is displayed for IPv6 addresses,
2870 as time offset string.
2874 flag may be used instead of an interface name.
2877 to display information about all interfaces in the system.
2880 flag limits this to interfaces that are down, and
2882 limits this to interfaces that are up.
2883 When no arguments are given,
2889 flag may be used to list all available interfaces on the system, with
2890 no other additional information.
2893 is specified, only interfaces of that type will be listed.
2895 will list only Ethernet adapters, excluding the loopback interface.
2896 Use of this flag is mutually exclusive
2897 with all other flags and commands, except for
2899 (only list interfaces that are down)
2902 (only list interfaces that are up).
2906 flag may be used to get more verbose status for an interface.
2910 flag may be used to list all of the interface cloners available on
2911 the system, with no additional information.
2912 Use of this flag is mutually exclusive with all other flags and commands.
2916 flag causes keying information for the interface, if available, to be
2918 For example, the values of 802.11 WEP keys and
2920 passphrases will be printed, if accessible to the current user.
2921 This information is not printed by default, as it may be considered
2924 If the network interface driver is not present in the kernel then
2926 will attempt to load it.
2929 flag disables this behavior.
2931 Only the super-user may modify the configuration of a network interface.
2933 Assign the IPv4 address
2935 with a network mask of
2939 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
2941 Add the IPv4 address
2943 with the CIDR network prefix
2949 as a synonym for the canonical form of the option
2951 .Dl # ifconfig em0 inet 192.0.2.45/28 add
2953 Remove the IPv4 address
2957 .Dl # ifconfig em0 inet 192.0.2.45 -alias
2959 Enable IPv6 functionality of the interface:
2960 .Dl # ifconfig em0 inet6 -ifdisabled
2962 Add the IPv6 address
2963 .Li 2001:DB8:DBDB::123/48
2966 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
2967 Note that lower case hexadecimal IPv6 addresses are acceptable.
2969 Remove the IPv6 address added in the above example,
2972 character as shorthand for the network prefix,
2975 as a synonym for the canonical form of the option
2977 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
2979 Configure a single CARP redundant address on igb0, and then switch it
2981 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
2982 .Dl # ifconfig igb0 vhid 1 state master
2984 Configure the interface
2986 to use 100baseTX, full duplex Ethernet media options:
2987 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
2989 Label the em0 interface as an uplink:
2990 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
2992 Create the software network interface
2994 .Dl # ifconfig gif1 create
2996 Destroy the software network interface
2998 .Dl # ifconfig gif1 destroy
3000 Display available wireless networks using
3002 .Dl # ifconfig wlan0 list scan
3004 Display inet and inet6 address subnet masks in CIDR notation
3005 .Dl # ifconfig -f inet:cidr,inet6:cidr
3007 Messages indicating the specified interface does not exist, the
3008 requested address is unknown, or the user is not privileged and
3009 tried to alter an interface's configuration.
3032 Basic IPv6 node operation requires a link-local address on each
3033 interface configured for IPv6.
3034 Normally, such an address is automatically configured by the
3035 kernel on each interface added to the system or enabled; this behavior may
3036 be disabled by setting per-interface flag
3037 .Cm -auto_linklocal .
3038 The default value of this flag is 1 and can be disabled by using the sysctl
3040 .Va net.inet6.ip6.auto_linklocal .
3042 Do not configure IPv6 addresses with no link-local address by using
3044 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob