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
33 .Nd configure network interface parameters
38 .Op Fl f Ar type Ns Cm \&: Ns Ar format
57 .Op Fl f Ar type Ns Cm \&: Ns Ar format
75 .Op Fl f Ar type Ns Cm \&: Ns Ar format
79 utility is used to assign an address
80 to a network interface and/or configure
81 network interface parameters.
84 utility must be used at boot time to define the network address
85 of each interface present on a machine; it may also be used at
86 a later time to redefine an interface's address
87 or other operating parameters.
89 The following options are available:
90 .Bl -tag -width indent
92 Display information about all interfaces in the system.
96 flag may be used instead of the
100 List all the interface cloners available on the system,
101 with no additional information.
102 Use of this flag is mutually exclusive with all other flags and commands.
104 Display only the interfaces that are down.
106 Include the driver name and unit number of the interface in the output.
107 This is normally the original name of the interface,
108 even if it has been renamed; it may differ from the original name
109 in some cases, such as
112 .Ar type Ns Cm \&: Ns Ar format Ns
113 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
115 Control the output format of
117 The format is specified as a comma-separated list of
118 .Ar type Ns Cm \&: Ns Ar format
122 section for more information
125 The output format can also be specified via the
127 environment variable.
130 flag can be supplied multiple times.
138 .Bl -tag -width ether
140 Adjust the display of inet and inet6 addresses:
142 .Bl -tag -width default -compact
147 Fully qualified domain names
150 Unqualified hostnames
155 Adjust the display of link-level ethernet (MAC) addresses:
157 .Bl -tag -width default -compact
159 Separate address segments with a colon
161 Separate address segments with a dash
163 Dotted notation, for example:
170 Adjust the display of inet address subnet masks:
172 .Bl -tag -width default -compact
174 CIDR notation, for example:
180 Dotted quad notation, for example:
183 Hexadecimal format, for example:
187 Adjust the display of inet6 address prefixes (subnet masks):
189 .Bl -tag -width default -compact
191 CIDR notation, for example:
199 Integer format, for example:
203 .It Fl G Ar groupname
204 Exclude members of the specified
211 should be specified as later override previous ones
213 may contain shell patterns in which case it should be quoted.
219 selects all interfaces.
220 .It Fl g Ar groupname
221 Limit the output to the members of the specified
226 is specified before other significant flags like, e.g.,
233 lists names of interfaces belonging to
235 Any other flags and arguments are ignored in this case.
239 should be specified as later override previous ones
241 may contain shell patterns in which case it should be quoted.
247 selects all interfaces.
249 Perform the actions inside the
254 will first attach to the
256 (by jail id or jail name) before performing the effects.
258 This allow network interfaces of
260 to be configured even if the
262 binary is not available in
265 Print keying information for the
269 For example, the values of 802.11 WEP keys and
271 passphrases will be printed, if accessible to the current user.
273 This information is not printed by default, as it may be considered
276 Display address lifetime for IPv6 addresses as time offset string.
278 List all available interfaces on the system,
279 with no other additional information.
283 is specified, only interfaces of that type will be listed.
291 will exclude loopback interfaces from the list of Ethernet interfaces.
292 This is a special case, because all the other synonyms of the
294 address family will include loopback interfaces in the list.
296 Use of this flag is mutually exclusive
297 with all other flags and commands, except for
303 Display the capability list and all
304 of the supported media for the specified interface.
306 Disable automatic loading of network interface drivers.
308 By default if the network interface driver is not present in the kernel
311 will attempt to load it.
313 Display only the interfaces that are up.
315 Get more verbose status for an interface.
318 the address is either a host name present in the host name data
321 or an IPv4 address expressed in the Internet standard
324 It is also possible to use the CIDR notation (also known as the
325 slash notation) to include the netmask.
326 That is, one can specify an address like
331 family, it is also possible to specify the prefix length using the slash
336 parameter below for more information.
341 is specified as a series of colon-separated hex digits.
342 This can be used to, for example,
343 set a new MAC address on an Ethernet interface, though the
344 mechanism used is not Ethernet specific.
348 keyword to set a randomly generated MAC address.
349 A randomly-generated MAC address might be the same as one already in use
351 Such duplications are extremely unlikely.
353 If the interface is already
354 up when the link-level address is modified,
355 it will be briefly brought down and
356 then brought back up again in order to ensure that the receive
357 filter in the underlying Ethernet hardware is properly reprogrammed.
358 .It Ar address_family
361 which affects interpretation of the remaining parameters.
362 Since an interface can receive transmissions in differing protocols
363 with different naming schemes, specifying the address family is recommended.
364 The address or protocol families currently
370 .Po with some exceptions, see
374 Default, if available.
385 Specify the address of the correspondent on the other end
386 of a point to point link.
389 parameter is a string of the form
397 utility displays the current configuration for a network interface
398 when no optional parameters are supplied.
399 If a protocol family is specified,
401 will report only the details specific to that protocol family.
403 When no arguments are given,
407 Only the super-user may modify the configuration of a network interface.
413 .Bl -tag -width indent
418 Introduced for compatibility
422 Establish an additional network address for this interface.
423 This is sometimes useful when changing network numbers, and
424 one wishes to accept packets addressed to the old interface.
425 If the address is on the same subnet as the first network address
426 for this interface, a non-conflicting netmask must be given.
431 Remove the network address specified.
432 This would be used if you incorrectly specified an alias, or it
433 was no longer needed.
434 If you have incorrectly set an NS address having the side effect
435 of specifying the host portion, removing all NS addresses will
436 allow you to respecify the host portion.
439 Specify that the address configured is an anycast address.
440 Based on the current specification,
441 only routers may configure anycast addresses.
442 Anycast address will not be used as source address of any of outgoing
445 Enable the use of the Address Resolution Protocol
448 between network level addresses and link level addresses (default).
449 This is currently implemented for mapping between Internet Protocol addresses
450 and IEEE 802 48-bit MAC addresses (Ethernet addresses).
452 Disable the use of the Address Resolution Protocol
455 If the Address Resolution Protocol is enabled,
456 the host will only reply to requests for its addresses,
457 and will never send any requests.
459 If the Address Resolution Protocol is enabled,
460 the host will perform normally,
461 sending out requests and listening for replies.
463 Enable the so-called sticky ARP mode for the interface.
464 If this option is enabled on the given interface, any resolved address is
465 marked as a static one and never expires. This may be used to increase
466 security of the network by preventing ARP spoofing or to reduce latency for
467 high-performance Ethernet networks where the time needed for ARP resolution is
468 too high. Please note that a similar feature is also provided for bridges. See
469 the sticky option in the
470 .Sx Bridge Interface Parameters
471 section. Enabling this
472 option may impact techniques which rely on ARP expiration/overwriting feature
473 such as load-balancers or high-availabity solutions such as
476 Disable the so-called sticky ARP mode for the interface (default).
477 Resolved addresses will expire normally respecting the kernel ARP
481 Specify the address to use to represent broadcasts to the
483 The default broadcast address is the address with a host part of all 1's.
485 Enable driver dependent debugging code; usually, this turns on
486 extra console error logging.
488 Disable driver dependent debugging code.
490 Put interface into permanently promiscuous mode.
492 Disable permanently promiscuous mode.
497 .It Cm description Ar value , Cm descr Ar value
498 Specify a description of the interface.
499 This can be used to label interfaces in situations where they may
500 otherwise be difficult to distinguish.
501 .It Cm -description , Cm -descr
502 Clear the interface description.
506 When an interface is marked
508 the system will not attempt to
509 transmit messages through that interface.
510 If possible, the interface will be reset to disable reception as well.
511 This action does not automatically disable routes using the interface.
512 .It Cm group Ar groupname
513 Assign the interface to a
517 may not be longer than 15 characters and must not end in a digit.
518 Any interface can be in multiple groups.
520 Cloned interfaces are members of their interface family group by default.
521 For example, a VLAN interface such as
523 is a member of the VLAN interface family group,
525 .It Cm -group Ar groupname
526 Remove the interface from the given
531 (lowermost 64bit of an IPv6 address)
533 .It Cm fib Ar fib_number
534 Specify interface FIB.
537 is assigned to all frames or packets received on that interface.
538 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
539 the default FIB (0) irrespective of the parent interface's FIB.
540 The kernel needs to be tuned to support more than the default FIB
543 kernel configuration option, or the
546 .It Cm tunnelfib Ar fib_number
550 is assigned to all packets encapsulated by tunnel interface, e.g.,
555 .It Cm maclabel Ar label
556 If Mandatory Access Control support is enabled in the kernel,
560 .\" .Xr maclabel 7 ) .
562 If the driver supports the media selection system, set the media type
565 Some interfaces support the mutually exclusive use of one of several
566 different physical media connectors.
567 For example, a 10Mbit/s Ethernet
568 interface might support the use of either AUI
569 or twisted pair connectors.
570 Setting the media type to
572 would change the currently active connector to the AUI port.
575 would activate twisted pair.
576 Refer to the interfaces' driver
577 specific documentation or man page for a complete list of the
579 .It Cm mediaopt Ar opts
580 If the driver supports the media selection system, set the specified
581 media options on the interface.
585 is a comma delimited list of options to apply to the interface.
586 Refer to the interfaces' driver specific man page for a complete
587 list of available options.
588 .It Fl mediaopt Ar opts
589 If the driver supports the media selection system, disable the
590 specified media options on the interface.
592 If the driver supports the media selection system, set the specified
593 operating mode on the interface to
595 For IEEE 802.11 wireless interfaces that support multiple operating modes
596 this directive is used to select between 802.11a
604 Set if the driver supports TX rate limiting.
605 .It Cm inst Ar minst , Cm instance Ar minst
606 Set the media instance to
608 This is useful for devices which have multiple physical layer interfaces
611 Set the interface name to
613 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
614 If the driver supports user-configurable checksum offloading,
615 enable receive (or transmit) checksum offloading on the interface.
616 The feature can be turned on selectively per protocol family.
618 .Cm rxcsum6 , txcsum6
624 Some drivers may not be able to enable these flags independently
625 of each other, so setting one may also set the other.
626 The driver will offload as much checksum work as it can reliably
627 support, the exact level of offloading varies between drivers.
628 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
629 If the driver supports user-configurable checksum offloading,
630 disable receive (or transmit) checksum offloading on the interface.
631 The feature can be turned off selectively per protocol family.
633 .Fl rxcsum6 , txcsum6
639 These settings may not always be independent of each other.
641 If the driver supports
643 segmentation offloading, enable TSO on the interface.
644 Some drivers may not be able to support TSO for
648 packets, so they may enable only one of them.
650 If the driver supports
652 segmentation offloading, disable TSO on the interface.
653 It will always disable TSO for
658 If the driver supports
660 segmentation offloading for
664 use one of these to selectively enabled it only for one protocol family.
666 If the driver supports
668 segmentation offloading for
672 use one of these to selectively disable it only for one protocol family.
674 If the driver supports
676 large receive offloading, enable LRO on the interface.
678 If the driver supports
680 large receive offloading, disable LRO on the interface.
682 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
683 segments the encrypted record into one or more
689 If the driver supports transmit TLS offload,
690 enable transmit TLS offload on the interface.
691 Some drivers may not be able to support transmit TLS offload for
695 packets, so they may enable only one of them.
697 If the driver supports transmit TLS offload,
698 disable transmit TLS offload on the interface.
699 It will always disable TLS for
704 Enable use of rate limiting (packet pacing) for TLS offload.
706 Disable use of rate limiting for TLS offload.
708 If the driver supports extended multi-page
710 buffers, enable them on the interface.
712 If the driver supports extended multi-page
714 buffers, disable them on the interface.
715 .It Cm wol , wol_ucast , wol_mcast , wol_magic
716 Enable Wake On Lan (WOL) support, if available.
717 WOL is a facility whereby a machine in a low power state may be woken
718 in response to a received packet.
719 There are three types of packets that may wake a system:
720 ucast (directed solely to the machine's mac address),
721 mcast (directed to a broadcast or multicast address),
724 .Po unicast or multicast frames with a
727 Not all devices support WOL, those that do indicate the mechanisms
728 they support in their capabilities.
730 is a synonym for enabling all available WOL mechanisms.
733 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
734 If the driver offers user-configurable VLAN support, enable
735 reception of extended frames, tag processing in hardware,
736 frame filtering in hardware, checksum offloading, or TSO on VLAN,
738 Note that this must be configured on a physical interface associated with
743 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
744 If the driver offers user-configurable VLAN support, disable
745 reception of extended frames, tag processing in hardware,
746 frame filtering in hardware, checksum offloading, or TSO on VLAN,
748 .It Cm vxlanhwcsum , vxlanhwtso
749 If the driver offers user-configurable VXLAN support, enable inner checksum
750 offloading (receive and transmit) or TSO on VXLAN, respectively.
751 Note that this must be configured on a physical interface associated with
756 The physical interface is either the interface specified as the vxlandev
757 or the interface hosting the vxlanlocal address.
758 The driver will offload as much checksum work and TSO as it can reliably
759 support, the exact level of offloading may vary between drivers.
760 .It Fl vxlanhwcsum , vxlanhwtso
761 If the driver offers user-configurable VXLAN support, disable checksum
762 offloading (receive and transmit) or TSO on VXLAN, respectively.
764 Move the interface to the
766 specified by name or JID.
767 If the jail has a virtual network stack, the interface will disappear
768 from the current environment and become visible to the jail.
770 Reclaim the interface from the
772 specified by name or JID.
773 If the jail has a virtual network stack, the interface will disappear
774 from the jail, and become visible to the current network environment.
778 feature and disable interrupts on the interface, if driver supports
783 feature and enable interrupt mode on the interface.
785 Create the specified network pseudo-device.
786 If the interface is given without a unit number, try to create a new
787 device with an arbitrary unit number.
788 If creation of an arbitrary device is successful, the new device name is
789 printed to standard output unless the interface is renamed or destroyed
794 Destroy the specified network pseudo-device.
799 Included for Solaris compatibility.
804 Included for Solaris compatibility.
806 Set the routing metric of the interface to
809 The routing metric is used by the routing protocol
811 Higher metrics have the effect of making a route
812 less favorable; metrics are counted as additional hops
813 to the destination network or host.
815 Set the maximum transmission unit of the interface to
817 default is interface specific.
818 The MTU is used to limit the size of packets that are transmitted on an
820 Not all interfaces support setting the MTU, and some interfaces have
822 .It Cm netmask Ar mask
825 Specify how much of the address to reserve for subdividing
826 networks into sub-networks.
827 The mask includes the network part of the local address
828 and the subnet part, which is taken from the host field of the address.
829 The mask can be specified as a single hexadecimal number
832 with a dot-notation Internet address,
833 or with a pseudo-network name listed in the network table
835 The mask contains 1's for the bit positions in the 32-bit address
836 which are to be used for the network and subnet parts,
837 and 0's for the host part.
838 The mask should contain at least the standard network portion,
839 and the subnet field should be contiguous with the network
842 The netmask can also be specified in CIDR notation after the address.
845 option above for more information.
846 .It Cm prefixlen Ar len
850 bits are reserved for subdividing networks into sub-networks.
853 must be integer, and for syntactical reason it must be between 0 to 128.
854 It is almost always 64 under the current IPv6 assignment rule.
855 If the parameter is omitted, 64 is used.
857 The prefix can also be specified using the slash notation after the address.
860 option above for more information.
865 Introduced for compatibility
869 .It Cm link Op Cm 0 No - Cm 2
871 Enable special processing of the link level of the interface.
872 These three options are interface specific in actual effect, however,
873 they are in general used to select special modes of operation.
875 of this is to enable SLIP compression, or to select the connector type
876 for some Ethernet cards.
877 Refer to the man page for the specific driver
878 for more information.
880 .It Fl link Op Cm 0 No - Cm 2
882 Disable special processing at the link level with the specified interface.
884 Put the interface in monitor mode.
885 No packets are transmitted, and received packets are discarded after
889 Take the interface out of monitor mode.
890 .It Cm pcp Ar priority_code_point
893 is an 3-bit field which refers to the IEEE 802.1p
894 class of service and maps to the frame priority level.
896 Stop tagging packets on the interface w/ the priority code point.
900 This may be used to enable an interface after an
902 It happens automatically when setting the first address on an interface.
903 If the interface was reset when previously marked down,
904 the hardware will be re-initialized.
906 .Ss ICMPv6 Neighbor Discovery Protocol Parameters
907 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
908 Note that the address family keyword
911 .Bl -tag -width indent
913 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
917 .Va net.inet6.ip6.accept_rtadv
918 controls whether this flag is set by default or not.
923 Set a flag to control whether routers from which the system accepts
924 Router Advertisement messages will be added to the Default Router List
928 flag is disabled, this flag has no effect.
932 .Va net.inet6.ip6.no_radr
933 controls whether this flag is set by default or not.
937 .It Cm auto_linklocal
938 Set a flag to perform automatic link-local address configuration when
939 the interface becomes available.
943 .Va net.inet6.ip6.auto_linklocal
944 controls whether this flag is set by default or not.
945 .It Cm -auto_linklocal
949 Set the specified interface as the default route when there is no
955 Set a flag to disable all of IPv6 network communications on the
957 Note that if there are already configured IPv6
958 addresses on that interface, all of them are marked as
960 and DAD will be performed when this flag is cleared.
964 When this flag is cleared and
966 flag is enabled, automatic configuration of a link-local address is
969 Set a flag to enable Neighbor Unreachability Detection.
973 .It Cm no_prefer_iface
974 Set a flag to not honor rule 5 of source address selection in RFC 3484.
975 In practice this means the address on the outgoing interface will not be
976 preferred, effectively yielding the decision to the address selection
977 policy table, configurable with
979 .It Cm -no_prefer_iface
981 .Cm no_prefer_iface .
983 Set a flag to disable Duplicate Address Detection.
989 The following parameters are specific for IPv6 addresses.
990 Note that the address family keyword
993 .Bl -tag -width indent
995 Set the IPv6 autoconfigured address bit.
997 Clear the IPv6 autoconfigured address bit.
999 Set the IPv6 deprecated address bit.
1001 Clear the IPv6 deprecated address bit.
1003 Set preferred lifetime for the address.
1004 .It Cm prefer_source
1005 Set a flag to prefer address as a candidate of the source address for
1007 .It Cm -prefer_source
1011 Set valid lifetime for the address.
1013 .Ss IEEE 802.11 Wireless Interfaces Cloning Parameters
1014 The following parameters are specific to cloning
1015 IEEE 802.11 wireless interfaces with the
1018 .Bl -tag -width indent
1019 .It Cm wlandev Ar device
1022 as the parent for the cloned device.
1023 .It Cm wlanmode Ar mode
1024 Specify the operating mode for this cloned device.
1042 The operating mode of a cloned interface cannot be changed.
1045 mode is actually implemented as an
1047 interface with special properties.
1048 .It Cm wlanbssid Ar bssid
1049 The 802.11 mac address to use for the bssid.
1050 This must be specified at create time for a legacy
1053 .It Cm wlanaddr Ar address
1054 The local mac address.
1055 If this is not specified then a mac address will automatically be assigned
1056 to the cloned device.
1057 Typically this address is the same as the address of the parent device
1060 parameter is specified then the driver will craft a unique address for
1061 the device (if supported).
1065 device as operating in
1069 devices have a fixed peer relationship and do not, for example, roam
1070 if their peer stops communicating.
1071 For completeness a Dynamic WDS (DWDS) interface may be marked as
1074 Request a unique local mac address for the cloned device.
1075 This is only possible if the device supports multiple mac addresses.
1076 To force use of the parent's mac address use
1079 Mark the cloned interface as depending on hardware support to
1080 track received beacons.
1081 To have beacons tracked in software use
1087 can also be used to indicate no beacons should
1088 be transmitted; this can be useful when creating a WDS configuration but
1090 interfaces can only be created as companions to an access point.
1092 .Ss Cloned IEEE 802.11 Wireless Interface Parameters
1093 The following parameters are specific to IEEE 802.11 wireless interfaces
1097 .Bl -tag -width indent
1099 Enable sending and receiving AMPDU frames when using 802.11n (default).
1100 The 802.11n specification states a compliant station must be capable
1101 of receiving AMPDU frames but transmission is optional.
1104 to disable all use of AMPDU with 802.11n.
1105 For testing and/or to work around interoperability problems one can use
1109 to control use of AMPDU in one direction.
1110 .It Cm ampdudensity Ar density
1111 Set the AMPDU density parameter used when operating with 802.11n.
1112 This parameter controls the inter-packet gap for AMPDU frames.
1113 The sending device normally controls this setting but a receiving station
1114 may request wider gaps.
1117 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
1120 is treated the same as 0.
1121 .It Cm ampdulimit Ar limit
1122 Set the limit on packet size for receiving AMPDU frames when operating
1126 are 8192, 16384, 32768, and 65536 but one can also specify
1127 just the unique prefix: 8, 16, 32, 64.
1128 Note the sender may limit the size of AMPDU frames to be less
1129 than the maximum specified by the receiving station.
1131 Enable sending and receiving AMSDU frames when using 802.11n.
1132 By default AMSDU is received but not transmitted.
1135 to disable all use of AMSDU with 802.11n.
1136 For testing and/or to work around interoperability problems one can use
1140 to control use of AMSDU in one direction.
1141 .It Cm amsdulimit Ar limit
1142 Set the limit on packet size for sending and receiving AMSDU frames
1143 when operating with 802.11n.
1146 are 7935 and 3839 (bytes).
1147 Note the sender may limit the size of AMSDU frames to be less
1148 than the maximum specified by the receiving station.
1149 Note also that devices are not required to support the 7935 limit,
1150 only 3839 is required by the specification and the larger value
1151 may require more memory to be dedicated to support functionality
1152 that is rarely used.
1154 When operating as an access point, pass packets between
1155 wireless clients directly (default).
1156 To instead let them pass up through the
1157 system and be forwarded using some other mechanism, use
1159 Disabling the internal bridging
1160 is useful when traffic is to be processed with
1162 .It Cm authmode Ar mode
1163 Set the desired authentication mode in infrastructure mode.
1164 Not all adapters support all modes.
1167 .Cm none , open , shared
1173 (IEEE WPA/WPA2/802.11i).
1178 modes are only useful when using an authentication service
1179 (a supplicant for client operation or an authenticator when
1180 operating as an access point).
1181 Modes are case insensitive.
1183 Enable background scanning when operating as a station.
1184 Background scanning is a technique whereby a station associated to
1185 an access point will temporarily leave the channel to scan for
1186 neighboring stations.
1187 This allows a station to maintain a cache of nearby access points
1188 so that roaming between access points can be done without
1189 a lengthy scan operation.
1190 Background scanning is done only when a station is not busy and
1191 any outbound traffic will cancel a scan operation.
1192 Background scanning should never cause packets to be lost though
1193 there may be some small latency if outbound traffic interrupts a
1195 By default background scanning is enabled if the device is capable.
1196 To disable background scanning, use
1198 Background scanning is controlled by the
1203 Background scanning must be enabled for roaming; this is an artifact
1204 of the current implementation and may not be required in the future.
1205 .It Cm bgscanidle Ar idletime
1206 Set the minimum time a station must be idle (not transmitting or
1207 receiving frames) before a background scan is initiated.
1210 parameter is specified in milliseconds.
1211 By default a station must be idle at least 250 milliseconds before
1212 a background scan is initiated.
1213 The idle time may not be set to less than 100 milliseconds.
1214 .It Cm bgscanintvl Ar interval
1215 Set the interval at which background scanning is attempted.
1218 parameter is specified in seconds.
1219 By default a background scan is considered every 300 seconds (5 minutes).
1222 may not be set to less than 15 seconds.
1223 .It Cm bintval Ar interval
1224 Set the interval at which beacon frames are sent when operating in
1228 parameter is specified in TU's (1024 usecs).
1229 By default beacon frames are transmitted every 100 TU's.
1230 .It Cm bmissthreshold Ar count
1231 Set the number of consecutive missed beacons at which the station
1232 will attempt to roam (i.e., search for a new access point).
1235 parameter must be in the range 1 to 255; though the
1236 upper bound may be reduced according to device capabilities.
1237 The default threshold is 7 consecutive missed beacons; but
1238 this may be overridden by the device driver.
1239 Another name for the
1243 .It Cm bssid Ar address
1244 Specify the MAC address of the access point to use when operating
1245 as a station in a BSS network.
1246 This overrides any automatic selection done by the system.
1247 To disable a previously selected access point, supply
1252 This option is useful when more than one access point uses the same SSID.
1253 Another name for the
1258 Enable packet bursting.
1259 Packet bursting is a transmission technique whereby the wireless
1260 medium is acquired once to send multiple frames and the interframe
1262 This technique can significantly increase throughput by reducing
1263 transmission overhead.
1264 Packet bursting is supported by the 802.11e QoS specification
1265 and some devices that do not support QoS may still be capable.
1266 By default packet bursting is enabled if a device is capable
1268 To disable packet bursting, use
1270 .It Cm chanlist Ar channels
1271 Set the desired channels to use when scanning for access
1272 points, neighbors in an IBSS network, or looking for unoccupied
1273 channels when operating as an access point.
1274 The set of channels is specified as a comma-separated list with
1275 each element in the list representing either a single channel number or a range
1278 Channel numbers must be in the range 1 to 255 and be permissible
1279 according to the operating characteristics of the device.
1280 .It Cm channel Ar number
1281 Set a single desired channel.
1282 Channels range from 1 to 255, but the exact selection available
1283 depends on the region your adaptor was manufactured for.
1289 will clear any desired channel and, if the device is marked up,
1290 force a scan for a channel to operate on.
1291 Alternatively the frequency, in megahertz, may be specified
1292 instead of the channel number.
1294 When there are several ways to use a channel the channel
1295 number/frequency may be appended with attributes to clarify.
1296 For example, if a device is capable of operating on channel 6
1297 with 802.11n and 802.11g then one can specify that g-only use
1298 should be used by specifying
1300 Similarly the channel width can be specified by appending it
1305 specifies a 40MHz wide channel.
1306 These attributes can be combined as in:
1309 The full set of flags specified following a
1319 Atheros Dynamic Turbo mode
1328 Atheros Static Turbo mode
1330 Atheros Dynamic Turbo mode, or appended to
1336 The full set of channel widths following a
1342 5MHz aka quarter-rate channel
1344 10MHz aka half-rate channel
1346 20MHz mostly for use in specifying
1349 40MHz mostly for use in specifying
1354 a 40MHz HT channel specification may include the location
1355 of the extension channel by appending
1359 for above and below,
1362 specifies 40MHz wide HT operation
1363 with the center channel at frequency 2437 and the extension channel above.
1364 .It Cm country Ar name
1365 Set the country code to use in calculating the regulatory constraints
1367 In particular the set of available channels, how the wireless device
1368 will operation on the channels, and the maximum transmit power that
1369 can be used on a channel are defined by this setting.
1370 Country/Region codes are specified as a 2-character abbreviation
1371 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1372 e.g., "ES" and "Spain".
1373 The set of country codes are taken from
1374 .Pa /etc/regdomain.xml
1379 Note that not all devices support changing the country code from a default
1380 setting; typically stored in EEPROM.
1388 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1389 DFS embodies several facilities including detection of overlapping
1390 radar signals, dynamic transmit power control, and channel selection
1391 according to a least-congested criteria.
1392 DFS support is mandatory for some 5GHz frequencies in certain
1393 locales (e.g., ETSI).
1394 By default DFS is enabled according to the regulatory definitions
1396 .Pa /etc/regdomain.xml
1397 and the current country code, regdomain,
1399 Note the underlying device (and driver) must support radar detection
1400 for full DFS support to work.
1401 To be fully compliant with the local regulatory agency frequencies that
1402 require DFS should not be used unless it is fully supported.
1405 to disable this functionality for testing.
1407 Enable support for the 802.11d specification (default).
1408 When this support is enabled in station mode, beacon frames that advertise
1409 a country code different than the currently configured country code will
1410 cause an event to be dispatched to user applications.
1411 This event can be used by the station to adopt that country code and
1412 operate according to the associated regulatory constraints.
1413 When operating as an access point with 802.11d enabled the beacon and
1414 probe response frames transmitted will advertise the current regulatory
1416 To disable 802.11d use
1419 Enable 802.11h support including spectrum management.
1420 When 802.11h is enabled beacon and probe response frames will have
1421 the SpectrumMgt bit set in the capabilities field and
1422 country and power constraint information elements will be present.
1423 802.11h support also includes handling Channel Switch Announcements (CSA)
1424 which are a mechanism to coordinate channel changes by an access point.
1425 By default 802.11h is enabled if the device is capable.
1426 To disable 802.11h use
1428 .It Cm deftxkey Ar index
1429 Set the default key to use for transmission.
1430 Typically this is only set when using WEP encryption.
1431 Note that you must set a default transmit key
1432 for the system to know which key to use in encrypting outbound traffic.
1435 is an alias for this request; it is provided for backwards compatibility.
1436 .It Cm dtimperiod Ar period
1439 period for transmitting buffered multicast data frames when
1440 operating in ap mode.
1443 specifies the number of beacon intervals between DTIM
1444 and must be in the range 1 to 15.
1445 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1447 Enable the use of quiet IE.
1448 Hostap will use this to silence other
1449 stations to reduce interference for radar detection when
1450 operating on 5GHz frequency and doth support is enabled.
1453 to disable this functionality.
1454 .It Cm quiet_period Ar period
1457 to the number of beacon intervals between the start of regularly
1458 scheduled quiet intervals defined by Quiet element.
1459 .It Cm quiet_count Ar count
1462 to the number of TBTTs until the beacon interval during which the
1463 next quiet interval shall start.
1464 A value of 1 indicates the quiet
1465 interval will start during the beacon interval starting at the next
1467 A value 0 is reserved.
1468 .It Cm quiet_offset Ar offset
1471 to the offset of the start of the quiet interval from the TBTT
1472 specified by the Quiet count, expressed in TUs.
1475 shall be less than one beacon interval.
1476 .It Cm quiet_duration Ar dur
1479 to the duration of the Quiet interval, expressed in TUs.
1480 The value should be less than beacon interval.
1482 Enable the use of Atheros Dynamic Turbo mode when communicating with
1483 another Dynamic Turbo-capable station.
1484 Dynamic Turbo mode is an Atheros-specific mechanism by which
1485 stations switch between normal 802.11 operation and a
1487 mode in which a 40MHz wide channel is used for communication.
1488 Stations using Dynamic Turbo mode operate boosted only when the
1489 channel is free of non-dturbo stations; when a non-dturbo station
1490 is identified on the channel all stations will automatically drop
1491 back to normal operation.
1492 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1493 Note that turbo mode (dynamic or static) is only allowed on some
1494 channels depending on the regulatory constraints; use the
1496 command to identify the channels where turbo mode may be used.
1497 To disable Dynamic Turbo mode use
1500 Enable Dynamic WDS (DWDS) support.
1501 DWDS is a facility by which 4-address traffic can be carried between
1502 stations operating in infrastructure mode.
1503 A station first associates to an access point and authenticates using
1504 normal procedures (e.g., WPA).
1505 Then 4-address frames are passed to carry traffic for stations
1506 operating on either side of the wireless link.
1507 DWDS extends the normal WDS mechanism by leveraging existing security
1508 protocols and eliminating static binding.
1510 When DWDS is enabled on an access point 4-address frames received from
1511 an authorized station will generate a
1515 This event should be used to create a WDS interface that is bound
1516 to the remote station (and usually plumbed into a bridge).
1517 Once the WDS interface is up and running 4-address traffic then logically
1518 flows through that interface.
1520 When DWDS is enabled on a station, traffic with a destination address
1521 different from the peer station are encapsulated in a 4-address frame
1522 and transmitted to the peer.
1523 All 4-address traffic uses the security information of the stations
1524 (e.g., cryptographic keys).
1525 A station is associated using 802.11n facilities may transport
1526 4-address traffic using these same mechanisms; this depends on available
1527 resources and capabilities of the device.
1528 The DWDS implementation guards against layer 2 routing loops of
1531 Enable the use of Atheros Fast Frames when communicating with
1532 another Fast Frames-capable station.
1533 Fast Frames are an encapsulation technique by which two 802.3
1534 frames are transmitted in a single 802.11 frame.
1535 This can noticeably improve throughput but requires that the
1536 receiving station understand how to decapsulate the frame.
1537 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1538 protocol extension so enabling use is safe when communicating with
1539 non-Atheros devices.
1540 By default, use of fast frames is enabled if the device is capable.
1541 To explicitly disable fast frames, use
1543 .It Cm fragthreshold Ar length
1544 Set the threshold for which transmitted frames are broken into fragments.
1547 argument is the frame size in bytes and must be in the range 256 to 2346.
1555 disables transmit fragmentation.
1556 Not all adapters honor the fragmentation threshold.
1558 When operating as an access point, do not broadcast the SSID
1559 in beacon frames or respond to probe request frames unless
1560 they are directed to the ap (i.e., they include the ap's SSID).
1561 By default, the SSID is included in beacon frames and
1562 undirected probe request frames are answered.
1563 To re-enable the broadcast of the SSID etc., use
1566 Enable use of High Throughput (HT) when using 802.11n (default).
1567 The 802.11n specification includes mechanisms for operation
1568 on 20MHz and 40MHz wide channels using different signalling mechanisms
1569 than specified in 802.11b, 802.11g, and 802.11a.
1570 Stations negotiate use of these facilities, termed HT20 and HT40,
1571 when they associate.
1572 To disable all use of 802.11n use
1574 To disable use of HT20 (e.g., to force only HT40 use) use
1576 To disable use of HT40 use
1579 HT configuration is used to
1582 when several choices are available.
1583 For example, if a station associates to an 11n-capable access point
1584 it controls whether the station uses legacy operation, HT20, or HT40.
1585 When an 11n-capable device is setup as an access point and
1586 Auto Channel Selection is used to locate a channel to operate on,
1587 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1588 on the selected channel.
1589 If a fixed channel is specified for a station then HT configuration can
1590 be given as part of the channel specification; e.g., 6:ht/20 to setup
1591 HT20 operation on channel 6.
1593 Enable use of compatibility support for pre-802.11n devices (default).
1594 The 802.11n protocol specification went through several incompatible iterations.
1595 Some vendors implemented 11n support to older specifications that
1596 will not interoperate with a purely 11n-compliant station.
1597 In particular the information elements included in management frames
1598 for old devices are different.
1599 When compatibility support is enabled both standard and compatible data
1601 Stations that associate using the compatibility mechanisms are flagged
1604 To disable compatibility support use
1606 .It Cm htprotmode Ar technique
1607 For interfaces operating in 802.11n, use the specified
1609 for protecting HT frames in a mixed legacy/HT network.
1610 The set of valid techniques is
1615 Technique names are case insensitive.
1617 Enable inactivity processing for stations associated to an
1618 access point (default).
1619 When operating as an access point the 802.11 layer monitors
1620 the activity of each associated station.
1621 When a station is inactive for 5 minutes it will send several
1623 to see if the station is still present.
1624 If no response is received then the station is deauthenticated.
1625 Applications that prefer to handle this work can disable this
1629 Set the location to use in calculating regulatory constraints.
1630 The location is also advertised in beacon and probe response frames
1631 when 802.11d is enabled with
1640 Display the list of channels available for use taking into account
1641 any restrictions set with the
1644 See the description of
1646 for more information.
1648 Display the adaptor's capabilities, including the operating
1651 Display the list of channels available for use.
1652 Channels are shown with their IEEE channel number, equivalent
1653 frequency, and usage modes.
1654 Channels identified as
1659 Channels identified as
1661 may be used only for Atheros' Static Turbo mode
1663 . Cm mediaopt turbo ) .
1664 Channels marked with a
1666 have a regulatory constraint that they be passively scanned.
1667 This means a station is not permitted to transmit on the channel until
1668 it identifies the channel is being used for 802.11 communication;
1669 typically by hearing a beacon frame from an access point operating
1672 is another way of requesting this information.
1673 By default a compacted list of channels is displayed; if the
1675 option is specified then all channels are shown.
1676 .It Cm list countries
1677 Display the set of country codes and regulatory domains that can be
1678 used in regulatory configuration.
1680 Display the current MAC Access Control List state.
1681 Each address is prefixed with a character that indicates the
1682 current policy applied to it:
1684 indicates the address is allowed access,
1686 indicates the address is denied access,
1688 indicates the address is present but the current policy open
1689 (so the ACL is not consulted).
1691 Displays the mesh routing table, used for forwarding packets on a mesh
1693 .It Cm list regdomain
1694 Display the current regulatory settings including the available channels
1695 and transmit power caps.
1697 Display the parameters that govern roaming operation.
1699 Display the parameters that govern transmit operation.
1701 Display the transmit power caps for each channel.
1703 Display the access points and/or ad-hoc neighbors
1704 located in the vicinity.
1705 This information may be updated automatically by the adapter
1708 request or through background scanning.
1709 Depending on the capabilities of the stations the following
1710 flags (capability codes) can be included in the output:
1717 Poll request capability.
1719 DSSS/OFDM capability.
1721 Extended Service Set (ESS).
1722 Indicates that the station is part of an infrastructure network
1723 rather than an IBSS/ad-hoc network.
1725 Independent Basic Service Set (IBSS).
1726 Indicates that the station is part of an ad-hoc network
1727 rather than an ESS network.
1730 The station requires authentication and encryption
1731 for all data frames exchanged within the BSS using cryptographic means
1732 such as WEP, TKIP, or AES-CCMP.
1734 Robust Secure Network (RSN).
1737 Indicates that the network is using short preambles,
1738 defined in 802.11b High Rate/DSSS PHY,
1739 and utilizes a 56 bit sync field
1740 rather than the 128 bit field used in long preamble mode.
1741 Short preambles are used to optionally
1742 improve throughput performance with 802.11g and 802.11b.
1744 Pollable capability.
1746 Short slot time capability.
1747 Indicates that the 802.11g network is using a short slot time
1748 because there are no legacy (802.11b) stations present.
1751 By default interesting information elements captured from the neighboring
1752 stations are displayed at the end of each row.
1753 Possible elements include:
1755 (station supports WME),
1757 (station supports WPA),
1759 (station supports WPS),
1761 (station supports 802.11i/RSN),
1763 (station supports 802.11n/HT communication),
1765 (station supports Atheros protocol extensions),
1767 (station supports unknown vendor-specific extensions).
1770 flag is used all the information elements and their
1771 contents will be shown.
1774 flag also enables display of long SSIDs.
1777 command is another way of requesting this information.
1779 When operating as an access point display the stations that are
1780 currently associated.
1781 When operating in ad-hoc mode display stations identified as
1782 neighbors in the IBSS.
1783 When operating in mesh mode display stations identified as
1784 neighbors in the MBSS.
1785 When operating in station mode display the access point.
1786 Capabilities advertised by the stations are described under
1790 The following flags can be included in the output:
1794 Indicates that the station is permitted to send/receive data frames.
1796 Extended Rate Phy (ERP).
1797 Indicates that the station is operating in an 802.11g network
1798 using extended transmit rates.
1800 High Throughput (HT).
1801 Indicates that the station is using HT transmit rates.
1804 follows immediately after then the station associated
1805 using deprecated mechanisms supported only when
1810 Indicates that the station is operating in power save mode.
1812 Quality of Service (QoS).
1813 Indicates that the station is using QoS encapsulation for
1815 QoS encapsulation is enabled only when WME mode is enabled.
1817 Short GI in HT 40MHz mode enabled.
1820 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1822 Transitional Security Network (TSN).
1823 Indicates that the station associated using TSN; see also
1827 Wi-Fi Protected Setup (WPS).
1828 Indicates that the station associated using WPS.
1830 Short GI in HT 20MHz mode enabled.
1833 By default information elements received from associated stations
1834 are displayed in a short form; the
1836 flag causes this information to be displayed symbolically.
1838 Display the current channel parameters to use when operating in WME mode.
1841 option is specified then both channel and BSS parameters are displayed
1842 for each AC (first channel, then BSS).
1843 When WME mode is enabled for an adaptor this information will be
1844 displayed with the regular status; this command is mostly useful
1845 for examining parameters when WME mode is disabled.
1846 See the description of the
1848 directive for information on the various parameters.
1849 .It Cm maxretry Ar count
1850 Set the maximum number of tries to use in sending unicast frames.
1851 The default setting is 6 but drivers may override this with a value
1853 .It Cm mcastrate Ar rate
1854 Set the rate for transmitting multicast/broadcast frames.
1855 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1856 This rate should be valid for the current operating conditions;
1857 if an invalid rate is specified drivers are free to chose an
1859 .It Cm mgtrate Ar rate
1860 Set the rate for transmitting management and/or control frames.
1861 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1863 Set the location to use in calculating regulatory constraints.
1864 The location is also advertised in beacon and probe response frames
1865 when 802.11d is enabled with
1874 Enable powersave operation.
1875 When operating as a client, the station will conserve power by
1876 periodically turning off the radio and listening for
1877 messages from the access point telling it there are packets waiting.
1878 The station must then retrieve the packets.
1879 Not all devices support power save operation as a client.
1880 The 802.11 specification requires that all access points support
1881 power save but some drivers do not.
1884 to disable powersave operation when operating as a client.
1885 .It Cm powersavesleep Ar sleep
1886 Set the desired max powersave sleep time in TU's (1024 usecs).
1887 By default the max powersave sleep time is 100 TU's.
1888 .It Cm protmode Ar technique
1889 For interfaces operating in 802.11g, use the specified
1891 for protecting OFDM frames in a mixed 11b/11g network.
1892 The set of valid techniques is
1898 Technique names are case insensitive.
1899 Not all devices support
1901 as a protection technique.
1903 When operating as an access point in 802.11g mode allow only
1904 11g-capable stations to associate (11b-only stations are not
1905 permitted to associate).
1906 To allow both 11g and 11b-only stations to associate, use
1909 When operating as an access point in 802.11n mode allow only
1910 HT-capable stations to associate (legacy stations are not
1911 permitted to associate).
1912 To allow both HT and legacy stations to associate, use
1914 .It Cm regdomain Ar sku
1915 Set the regulatory domain to use in calculating the regulatory constraints
1917 In particular the set of available channels, how the wireless device
1918 will operation on the channels, and the maximum transmit power that
1919 can be used on a channel are defined by this setting.
1920 Regdomain codes (SKU's) are taken from
1921 .Pa /etc/regdomain.xml
1926 Note that not all devices support changing the regdomain from a default
1927 setting; typically stored in EEPROM.
1935 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1937 Note that RIFS must be supported by both the station and access point
1941 .It Cm roam:rate Ar rate
1942 Set the threshold for controlling roaming when operating in a BSS.
1945 parameter specifies the transmit rate in megabits
1946 at which roaming should be considered.
1947 If the current transmit rate drops below this setting and background scanning
1948 is enabled, then the system will check if a more desirable access point is
1949 available and switch over to it.
1950 The current scan cache contents are used if they are considered
1951 valid according to the
1953 parameter; otherwise a background scan operation is triggered before
1954 any selection occurs.
1955 Each channel type has a separate rate threshold; the default values are:
1956 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1957 .It Cm roam:rssi Ar rssi
1958 Set the threshold for controlling roaming when operating in a BSS.
1961 parameter specifies the receive signal strength in dBm units
1962 at which roaming should be considered.
1963 If the current rssi drops below this setting and background scanning
1964 is enabled, then the system will check if a more desirable access point is
1965 available and switch over to it.
1966 The current scan cache contents are used if they are considered
1967 valid according to the
1969 parameter; otherwise a background scan operation is triggered before
1970 any selection occurs.
1971 Each channel type has a separate rssi threshold; the default values are
1973 .It Cm roaming Ar mode
1974 When operating as a station, control how the system will
1975 behave when communication with the current access point
1979 argument may be one of
1981 (leave it to the hardware device to decide),
1983 (handle either in the device or the operating system\[em]as appropriate),
1985 (do nothing until explicitly instructed).
1986 By default, the device is left to handle this if it is
1987 capable; otherwise, the operating system will automatically
1988 attempt to reestablish communication.
1989 Manual mode is used by applications such as
1990 .Xr wpa_supplicant 8
1991 that want to control the selection of an access point.
1992 .It Cm rtsthreshold Ar length
1993 Set the threshold for which
1994 transmitted frames are preceded by transmission of an
2000 is the frame size in bytes and must be in the range 1 to 2346.
2008 disables transmission of RTS frames.
2009 Not all adapters support setting the RTS threshold.
2011 Initiate a scan of neighboring stations, wait for it to complete, and
2012 display all stations found.
2013 Only the super-user can initiate a scan.
2016 for information on the display.
2017 By default a background scan is done; otherwise a foreground
2018 scan is done and the station may roam to a different access point.
2021 request can be used to show recent scan results without
2022 initiating a new scan.
2023 .It Cm scanvalid Ar threshold
2024 Set the maximum time the scan cache contents are considered valid;
2025 i.e., will be used without first triggering a scan operation to
2029 parameter is specified in seconds and defaults to 60 seconds.
2030 The minimum setting for
2033 One should take care setting this threshold; if it is set too low
2034 then attempts to roam to another access point may trigger unnecessary
2035 background scan operations.
2037 Enable use of Short Guard Interval when operating in 802.11n
2039 NB: this currently enables Short GI on both HT40 and HT20 channels.
2040 To disable Short GI use
2043 Enable use of Static Spatial Multiplexing Power Save (SMPS)
2044 when operating in 802.11n.
2045 A station operating with Static SMPS maintains only a single
2046 receive chain active (this can significantly reduce power consumption).
2050 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
2051 when operating in 802.11n.
2052 A station operating with Dynamic SMPS maintains only a single
2053 receive chain active but switches to multiple receive chains when it
2054 receives an RTS frame (this can significantly reduce power consumption).
2055 Note that stations cannot distinguish between RTS/CTS intended to
2056 enable multiple receive chains and those used for other purposes.
2060 Set the desired Service Set Identifier (aka network name).
2061 The SSID is a string up to 32 characters
2062 in length and may be specified as either a normal string or in
2063 hexadecimal when preceded by
2065 Additionally, the SSID may be cleared by setting it to
2067 .It Cm tdmaslot Ar slot
2068 When operating with TDMA, use the specified
2073 is a number between 0 and the maximum number of slots in the BSS.
2074 Note that a station configured as slot 0 is a master and
2075 will broadcast beacon frames advertising the BSS;
2076 stations configured to use other slots will always
2077 scan to locate a master before they ever transmit.
2081 .It Cm tdmaslotcnt Ar cnt
2082 When operating with TDMA, setup a BSS with
2085 The slot count may be at most 8.
2086 The current implementation is only tested with two stations
2087 (i.e., point to point applications).
2088 This setting is only meaningful when a station is configured as slot 0;
2089 other stations adopt this setting from the BSS they join.
2093 .It Cm tdmaslotlen Ar len
2094 When operating with TDMA, setup a BSS such that each station has a slot
2097 The slot length must be at least 150 microseconds (1/8 TU)
2098 and no more than 65 milliseconds.
2099 Note that setting too small a slot length may result in poor channel
2100 bandwidth utilization due to factors such as timer granularity and
2102 This setting is only meaningful when a station is configured as slot 0;
2103 other stations adopt this setting from the BSS they join.
2106 is set to 10 milliseconds.
2107 .It Cm tdmabintval Ar intval
2108 When operating with TDMA, setup a BSS such that beacons are transmitted every
2110 superframes to synchronize the TDMA slot timing.
2111 A superframe is defined as the number of slots times the slot length; e.g.,
2112 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
2113 The beacon interval may not be zero.
2116 causes the timers to be resynchronized more often; this can be help if
2117 significant timer drift is observed.
2122 When operating as an access point with WPA/802.11i allow legacy
2123 stations to associate using static key WEP and open authentication.
2124 To disallow legacy station use of WEP, use
2126 .It Cm txpower Ar power
2127 Set the power used to transmit frames.
2130 argument is specified in .5 dBm units.
2131 Out of range values are truncated.
2132 Typically only a few discrete power settings are available and
2133 the driver will use the setting closest to the specified value.
2134 Not all adapters support changing the transmit power.
2135 .It Cm ucastrate Ar rate
2136 Set a fixed rate for transmitting unicast frames.
2137 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
2138 This rate should be valid for the current operating conditions;
2139 if an invalid rate is specified drivers are free to chose an
2141 .It Cm wepmode Ar mode
2142 Set the desired WEP mode.
2143 Not all adapters support all modes.
2144 The set of valid modes is
2150 mode explicitly tells the adaptor to allow association with access
2151 points which allow both encrypted and unencrypted traffic.
2154 means that the access point must only allow encrypted connections.
2157 is generally another name for
2159 Modes are case insensitive.
2160 .It Cm weptxkey Ar index
2161 Set the WEP key to be used for transmission.
2162 This is the same as setting the default transmission key with
2164 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
2165 Set the selected WEP key.
2168 is not given, key 1 is set.
2169 A WEP key will be either 5 or 13
2170 characters (40 or 104 bits) depending on the local network and the
2171 capabilities of the adaptor.
2172 It may be specified either as a plain
2173 string or as a string of hexadecimal digits preceded by
2175 For maximum portability, hex keys are recommended;
2176 the mapping of text keys to WEP encryption is usually driver-specific.
2177 In particular, the Windows drivers do this mapping differently to
2179 A key may be cleared by setting it to
2181 If WEP is supported then there are at least four keys.
2182 Some adapters support more than four keys.
2183 If that is the case, then the first four keys
2184 (1-4) will be the standard temporary keys and any others will be adaptor
2185 specific keys such as permanent keys stored in NVRAM.
2187 Note that you must set a default transmit key with
2189 for the system to know which key to use in encrypting outbound traffic.
2191 Enable Wireless Multimedia Extensions (WME) support, if available,
2192 for the specified interface.
2193 WME is a subset of the IEEE 802.11e standard to support the
2194 efficient communication of realtime and multimedia data.
2195 To disable WME support, use
2197 Another name for this parameter is
2200 The following parameters are meaningful only when WME support is in use.
2201 Parameters are specified per-AC (Access Category) and
2202 split into those that are used by a station when acting
2203 as an access point and those for client stations in the BSS.
2204 The latter are received from the access point and may not be changed
2206 The following Access Categories are recognized:
2208 .Bl -tag -width ".Cm AC_BK" -compact
2212 best effort delivery,
2227 AC parameters are case-insensitive.
2228 Traffic classification is done in the operating system using the
2229 vlan priority associated with data frames or the
2230 ToS (Type of Service) indication in IP-encapsulated frames.
2231 If neither information is present, traffic is assigned to the
2232 Best Effort (BE) category.
2233 .Bl -tag -width indent
2235 Set the ACK policy for QoS transmissions by the local station;
2236 this controls whether or not data frames transmitted by a station
2237 require an ACK response from the receiving station.
2238 To disable waiting for an ACK use
2240 This parameter is applied only to the local station.
2242 Enable the Admission Control Mandatory (ACM) mechanism
2243 for transmissions by the local station.
2244 To disable the ACM use
2246 On stations in a BSS this parameter is read-only and indicates
2247 the setting received from the access point.
2248 NB: ACM is not supported right now.
2249 .It Cm aifs Ar ac Ar count
2250 Set the Arbitration Inter Frame Spacing (AIFS)
2251 channel access parameter to use for transmissions
2252 by the local station.
2253 On stations in a BSS this parameter is read-only and indicates
2254 the setting received from the access point.
2255 .It Cm cwmin Ar ac Ar count
2256 Set the CWmin channel access parameter to use for transmissions
2257 by the local station.
2258 On stations in a BSS this parameter is read-only and indicates
2259 the setting received from the access point.
2260 .It Cm cwmax Ar ac Ar count
2261 Set the CWmax channel access parameter to use for transmissions
2262 by the local station.
2263 On stations in a BSS this parameter is read-only and indicates
2264 the setting received from the access point.
2265 .It Cm txoplimit Ar ac Ar limit
2266 Set the Transmission Opportunity Limit channel access parameter
2267 to use for transmissions by the local station.
2268 This parameter defines an interval of time when a WME station
2269 has the right to initiate transmissions onto the wireless medium.
2270 On stations in a BSS this parameter is read-only and indicates
2271 the setting received from the access point.
2272 .It Cm bss:aifs Ar ac Ar count
2273 Set the AIFS channel access parameter to send to stations in a BSS.
2274 This parameter is meaningful only when operating in ap mode.
2275 .It Cm bss:cwmin Ar ac Ar count
2276 Set the CWmin channel access parameter to send to stations in a BSS.
2277 This parameter is meaningful only when operating in ap mode.
2278 .It Cm bss:cwmax Ar ac Ar count
2279 Set the CWmax channel access parameter to send to stations in a BSS.
2280 This parameter is meaningful only when operating in ap mode.
2281 .It Cm bss:txoplimit Ar ac Ar limit
2282 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2283 This parameter is meaningful only when operating in ap mode.
2286 Enable Wireless Privacy Subscriber support.
2287 Note that WPS support requires a WPS-capable supplicant.
2288 To disable this function use
2291 .Ss MAC-Based Access Control List Parameters
2292 The following parameters support an optional access control list
2293 feature available with some adapters when operating in ap mode; see
2295 This facility allows an access point to accept/deny association
2296 requests based on the MAC address of the station.
2297 Note that this feature does not significantly enhance security
2298 as MAC address spoofing is easy to do.
2299 .Bl -tag -width indent
2300 .It Cm mac:add Ar address
2301 Add the specified MAC address to the database.
2302 Depending on the policy setting association requests from the
2303 specified station will be allowed or denied.
2305 Set the ACL policy to permit association only by
2306 stations registered in the database.
2307 .It Cm mac:del Ar address
2308 Delete the specified MAC address from the database.
2310 Set the ACL policy to deny association only by
2311 stations registered in the database.
2312 .It Cm mac:kick Ar address
2313 Force the specified station to be deauthenticated.
2314 This typically is done to block a station after updating the
2317 Set the ACL policy to allow all stations to associate.
2319 Delete all entries in the database.
2321 Set the ACL policy to permit association only by
2322 stations approved by a RADIUS server.
2323 Note that this feature requires the
2325 program be configured to do the right thing
2326 as it handles the RADIUS processing
2327 (and marks stations as authorized).
2329 .Ss Mesh Mode Wireless Interface Parameters
2330 The following parameters are related to a wireless interface operating in mesh
2332 .Bl -tag -width indent
2333 .It Cm meshid Ar meshid
2334 Set the desired Mesh Identifier.
2335 The Mesh ID is a string up to 32 characters in length.
2336 A mesh interface must have a Mesh Identifier specified
2337 to reach an operational state.
2338 .It Cm meshttl Ar ttl
2341 for mesh forwarded packets;
2342 this is the number of hops a packet may be forwarded before
2344 The default setting for
2348 Enable or disable peering with neighbor mesh stations.
2349 Stations must peer before any data packets can be exchanged.
2354 Enable or disable forwarding packets by a mesh interface.
2359 This attribute specifies whether or not the mesh STA activates mesh gate
2364 .It Cm meshmetric Ar protocol
2367 as the link metric protocol used on a mesh network.
2368 The default protocol is called
2370 The mesh interface will restart after changing this setting.
2371 .It Cm meshpath Ar protocol
2374 as the path selection protocol used on a mesh network.
2375 The only available protocol at the moment is called
2377 (Hybrid Wireless Mesh Protocol).
2378 The mesh interface will restart after changing this setting.
2379 .It Cm hwmprootmode Ar mode
2380 Stations on a mesh network can operate as
2382 Root nodes try to find paths to all mesh nodes and advertise themselves
2384 When there is a root mesh node on a network, other mesh nodes can setup
2385 paths between themselves faster because they can use the root node
2386 to find the destination.
2387 This path may not be the best, but on-demand
2388 routing will eventually find the best path.
2389 The following modes are recognized:
2391 .Bl -tag -width ".Cm PROACTIVE" -compact
2395 Send broadcast path requests every two seconds.
2396 Nodes on the mesh without a path to this root mesh station with try to
2397 discover a path to us.
2399 Send broadcast path requests every two seconds and every node must reply
2400 with a path reply even if it already has a path to this root mesh station.
2402 Send broadcast root announcement (RANN) frames.
2403 Nodes on the mesh without a path to this root mesh station with try to
2404 discover a path to us.
2410 .It Cm hwmpmaxhops Ar cnt
2411 Set the maximum number of hops allowed in an HMWP path to
2413 The default setting for
2417 .Ss Compatibility Parameters
2418 The following parameters are for compatibility with other systems:
2419 .Bl -tag -width indent
2421 Another name for the
2427 .It Cm stationname Ar name
2428 Set the name of this station.
2429 The station name is not part of the IEEE 802.11
2430 protocol though some interfaces support it.
2432 seems to be meaningful to identical or virtually identical equipment.
2433 Setting the station name is identical in syntax to setting the SSID.
2440 Another way of saying
2446 Another way of saying
2452 Another way of saying:
2453 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2459 .Ar n : k1 , k2 , k3 , k4
2462 Another way of saying
2463 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2468 Another way of saying
2474 .Ss Bridge Interface Parameters
2475 The following parameters are specific to bridge interfaces:
2476 .Bl -tag -width indent
2477 .It Cm addm Ar interface
2478 Add the interface named by
2480 as a member of the bridge.
2481 The interface is put into promiscuous mode
2482 so that it can receive every packet sent on the network.
2483 .It Cm deletem Ar interface
2484 Remove the interface named by
2487 Promiscuous mode is disabled on the interface when
2488 it is removed from the bridge.
2489 .It Cm maxaddr Ar size
2490 Set the size of the bridge address cache to
2492 The default is 2000 entries.
2493 .It Cm timeout Ar seconds
2494 Set the timeout of address cache entries to
2499 is zero, then address cache entries will not be expired.
2500 The default is 1200 seconds.
2502 Display the addresses that have been learned by the bridge.
2503 .It Cm static Ar interface-name Ar address
2504 Add a static entry into the address cache pointing to
2505 .Ar interface-name .
2506 Static entries are never aged out of the cache or re-placed, even if the
2507 address is seen on a different interface.
2508 .It Cm deladdr Ar address
2511 from the address cache.
2513 Delete all dynamically-learned addresses from the address cache.
2515 Delete all addresses, including static addresses, from the address cache.
2516 .It Cm discover Ar interface
2517 Mark an interface as a
2520 When the bridge has no address cache entry
2521 (either dynamic or static)
2522 for the destination address of a packet,
2523 the bridge will forward the packet to all
2524 member interfaces marked as
2526 This is the default for all interfaces added to a bridge.
2527 .It Cm -discover Ar interface
2530 attribute on a member interface.
2531 For packets without the
2533 attribute, the only packets forwarded on the interface are broadcast
2534 or multicast packets and packets for which the destination address
2535 is known to be on the interface's segment.
2536 .It Cm learn Ar interface
2537 Mark an interface as a
2540 When a packet arrives on such an interface, the source
2541 address of the packet is entered into the address cache as being a
2542 destination address on the interface's segment.
2543 This is the default for all interfaces added to a bridge.
2544 .It Cm -learn Ar interface
2547 attribute on a member interface.
2548 .It Cm sticky Ar interface
2549 Mark an interface as a
2552 Dynamically learned address entries are treated at static once entered into
2554 Sticky entries are never aged out of the cache or replaced, even if the
2555 address is seen on a different interface.
2556 .It Cm -sticky Ar interface
2559 attribute on a member interface.
2560 .It Cm private Ar interface
2561 Mark an interface as a
2564 A private interface does not forward any traffic to any other port that is also
2565 a private interface.
2566 .It Cm -private Ar interface
2569 attribute on a member interface.
2570 .It Cm span Ar interface
2571 Add the interface named by
2573 as a span port on the bridge.
2574 Span ports transmit a copy of every frame received by the bridge.
2575 This is most useful for snooping a bridged network passively on
2576 another host connected to one of the span ports of the bridge.
2577 .It Cm -span Ar interface
2578 Delete the interface named by
2580 from the list of span ports of the bridge.
2581 .It Cm stp Ar interface
2582 Enable Spanning Tree protocol on
2586 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2587 Spanning Tree is used to detect and remove loops in a network topology.
2588 .It Cm -stp Ar interface
2589 Disable Spanning Tree protocol on
2591 This is the default for all interfaces added to a bridge.
2592 .It Cm edge Ar interface
2596 An edge port connects directly to end stations cannot create bridging
2597 loops in the network, this allows it to transition straight to forwarding.
2598 .It Cm -edge Ar interface
2599 Disable edge status on
2601 .It Cm autoedge Ar interface
2604 to automatically detect edge status.
2605 This is the default for all interfaces added to a bridge.
2606 .It Cm -autoedge Ar interface
2607 Disable automatic edge status on
2609 .It Cm ptp Ar interface
2612 as a point to point link.
2613 This is required for straight transitions to forwarding and
2614 should be enabled on a direct link to another RSTP capable switch.
2615 .It Cm -ptp Ar interface
2616 Disable point to point link status on
2618 This should be disabled for a half duplex link and for an interface
2619 connected to a shared network segment,
2620 like a hub or a wireless network.
2621 .It Cm autoptp Ar interface
2622 Automatically detect the point to point status on
2624 by checking the full duplex link status.
2625 This is the default for interfaces added to the bridge.
2626 .It Cm -autoptp Ar interface
2627 Disable automatic point to point link detection on
2629 .It Cm maxage Ar seconds
2630 Set the time that a Spanning Tree protocol configuration is valid.
2631 The default is 20 seconds.
2632 The minimum is 6 seconds and the maximum is 40 seconds.
2633 .It Cm fwddelay Ar seconds
2634 Set the time that must pass before an interface begins forwarding
2635 packets when Spanning Tree is enabled.
2636 The default is 15 seconds.
2637 The minimum is 4 seconds and the maximum is 30 seconds.
2638 .It Cm hellotime Ar seconds
2639 Set the time between broadcasting of Spanning Tree protocol
2640 configuration messages.
2641 The hello time may only be changed when operating in legacy stp mode.
2642 The default is 2 seconds.
2643 The minimum is 1 second and the maximum is 2 seconds.
2644 .It Cm priority Ar value
2645 Set the bridge priority for Spanning Tree.
2646 The default is 32768.
2647 The minimum is 0 and the maximum is 61440.
2648 .It Cm proto Ar value
2649 Set the Spanning Tree protocol.
2650 The default is rstp.
2651 The available options are stp and rstp.
2652 .It Cm holdcnt Ar value
2653 Set the transmit hold count for Spanning Tree.
2654 This is the number of packets transmitted before being rate limited.
2656 The minimum is 1 and the maximum is 10.
2657 .It Cm ifpriority Ar interface Ar value
2658 Set the Spanning Tree priority of
2663 The minimum is 0 and the maximum is 240.
2664 .It Cm ifpathcost Ar interface Ar value
2665 Set the Spanning Tree path cost of
2669 The default is calculated from the link speed.
2670 To change a previously selected path cost back to automatic, set the
2672 The minimum is 1 and the maximum is 200000000.
2673 .It Cm ifmaxaddr Ar interface Ar size
2674 Set the maximum number of hosts allowed from an interface, packets with unknown
2675 source addresses are dropped until an existing host cache entry expires or is
2677 Set to 0 to disable.
2679 .Ss Link Aggregation and Link Failover Parameters
2680 The following parameters are specific to lagg interfaces:
2681 .Bl -tag -width indent
2682 .It Cm laggtype Ar type
2683 When creating a lagg interface the type can be specified as either
2687 If not specified ethernet is the default lagg type.
2688 .It Cm laggport Ar interface
2689 Add the interface named by
2691 as a port of the aggregation interface.
2692 .It Cm -laggport Ar interface
2693 Remove the interface named by
2695 from the aggregation interface.
2696 .It Cm laggproto Ar proto
2697 Set the aggregation protocol.
2700 The available options are
2708 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2709 Set the packet layers to hash for aggregation protocols which load balance.
2712 The options can be combined using commas.
2714 .Bl -tag -width ".Cm l2" -compact
2716 src/dst mac address and optional vlan number.
2718 src/dst address for IPv4 or IPv6.
2720 src/dst port for TCP/UDP/SCTP.
2723 Enable local hash computation for RSS hash on the interface.
2728 modes will use the RSS hash from the network card if available
2729 to avoid computing one, this may give poor traffic distribution
2730 if the hash is invalid or uses less of the protocol header information.
2732 disables use of RSS hash from the network card.
2733 The default value can be set via the
2734 .Va net.link.lagg.default_use_flowid
2745 Use the RSS hash from the network card if available.
2746 .It Cm flowid_shift Ar number
2747 Set a shift parameter for RSS local hash computation.
2748 Hash is calculated by using flowid bits in a packet header mbuf
2749 which are shifted by the number of this parameter.
2751 Enable selection of egress ports based on the native
2753 domain for the packets being transmitted.
2754 This is currently only implemented for lacp mode.
2757 hardware, running a kernel compiled with the
2759 option, and when interfaces from multiple
2761 domains are ports of the aggregation interface.
2763 Disable selection of egress ports based on the native
2765 domain for the packets being transmitted.
2766 .It Cm lacp_fast_timeout
2767 Enable lacp fast-timeout on the interface.
2768 .It Cm -lacp_fast_timeout
2769 Disable lacp fast-timeout on the interface.
2771 Enable lacp strict compliance on the interface.
2772 The default value can be set via the
2773 .Va net.link.lagg.lacp.default_strict_mode
2784 Disable lacp strict compliance on the interface.
2785 .It Cm rr_limit Ar number
2786 Configure a stride for an interface in round-robin mode.
2787 The default stride is 1.
2789 .Ss Generic IP Tunnel Parameters
2790 The following parameters apply to IP tunnel interfaces,
2792 .Bl -tag -width indent
2793 .It Cm tunnel Ar src_addr dest_addr
2794 Configure the physical source and destination address for IP tunnel
2800 are interpreted as the outer source/destination for the encapsulating
2803 Unconfigure the physical source and destination address for IP tunnel
2804 interfaces previously configured with
2807 Another name for the
2810 .It Cm accept_rev_ethip_ver
2811 Set a flag to accept both correct EtherIP packets and ones
2812 with reversed version field.
2814 This is for backward compatibility with
2816 6.2, 6.3, 7.0, and 7.1.
2817 .It Cm -accept_rev_ethip_ver
2819 .Cm accept_rev_ethip_ver .
2820 .It Cm ignore_source
2821 Set a flag to accept encapsulated packets destined to this host
2822 independently from source address.
2823 This may be useful for hosts, that receive encapsulated packets
2824 from the load balancers.
2825 .It Cm -ignore_source
2828 .It Cm send_rev_ethip_ver
2829 Set a flag to send EtherIP packets with reversed version
2830 field intentionally.
2831 Disabled by default.
2832 This is for backward compatibility with
2834 6.2, 6.3, 7.0, and 7.1.
2835 .It Cm -send_rev_ethip_ver
2837 .Cm send_rev_ethip_ver .
2839 .Ss GRE Tunnel Parameters
2840 The following parameters apply to GRE tunnel interfaces,
2842 .Bl -tag -width indent
2843 .It Cm tunnel Ar src_addr dest_addr
2844 Configure the physical source and destination address for GRE tunnel
2850 are interpreted as the outer source/destination for the encapsulating
2853 Unconfigure the physical source and destination address for GRE tunnel
2854 interfaces previously configured with
2857 Another name for the
2860 .It Cm grekey Ar key
2861 Configure the GRE key to be used for outgoing packets.
2863 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2864 This command will result in a four byte MTU reduction on the interface.
2866 .Ss Packet Filter State Table Sychronisation Parameters
2867 The following parameters are specific to
2870 .Bl -tag -width indent
2871 .It Cm syncdev Ar iface
2872 Use the specified interface
2873 to send and receive pfsync state synchronisation messages.
2875 Stop sending pfsync state synchronisation messages over the network.
2876 .It Cm syncpeer Ar peer_address
2877 Set the destination address for the state synchronization messages sent.
2880 is normally the IPv4 or IPv6 address of the other host taking
2881 part in the pfsync cluster.
2885 is set to a unicast IP address, the pfsync link will behave
2886 as point-to-point rather than using multicast to broadcast the messages.
2890 is set to ff12::f0, the state synchronization
2891 messages will be broadcast using multicast over IPv6.
2894 Packets will then be broadcast using multicast over IPv4.
2896 Set the maximum number of updates for a single state which
2897 can be collapsed into one.
2898 This is an 8-bit number; the default value is 128.
2900 Defer transmission of the first packet in a state until a peer has
2901 acknowledged that the associated state has been inserted.
2903 Do not defer the first packet in a state.
2904 This is the default.
2906 Configure message format for compatibility with older versions of FreeBSD.
2912 The following parameters are specific to
2915 .Bl -tag -width indent
2916 .It Cm vlan Ar vlan_tag
2917 Set the VLAN tag value to
2919 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2920 or 802.1ad VLAN header for packets sent from the
2927 must both be set at the same time.
2928 .It Cm vlanproto Ar vlan_proto
2929 Set the VLAN encapsulation protocol to
2931 Supported encapsulation protocols are currently:
2940 .It Cm vlanpcp Ar priority_code_point
2943 is an 3-bit field which refers to the IEEE 802.1p
2944 class of service and maps to the frame priority level.
2946 Values in order of priority are:
2948 .Pq Dv Background (lowest) ,
2950 .Pq Dv Best effort (default) ,
2952 .Pq Dv Excellent effort ,
2954 .Pq Dv Critical applications ,
2956 .Pq Dv Video, < 100ms latency and jitter ,
2958 .Pq Dv Voice, < 10ms latency and jitter ,
2960 .Pq Dv Internetwork control ,
2962 .Pq Dv Network control (highest) .
2963 .It Cm vlandev Ar iface
2964 Associate the physical interface
2969 Packets transmitted through the
2972 diverted to the specified physical interface
2974 with 802.1Q VLAN encapsulation.
2975 Packets with 802.1Q encapsulation received
2976 by the parent interface with the correct VLAN Identifier will be diverted to
2982 interface is assigned a
2983 copy of the parent interface's flags and the parent's Ethernet address.
2988 must both be set at the same time.
2991 interface already has
2992 a physical interface associated with it, this command will fail.
2994 change the association to another physical interface, the existing
2995 association must be cleared first.
2997 Note: if the hardware tagging capability
2998 is set on the parent interface, the
3001 interface's behavior changes:
3004 interface recognizes that the
3005 parent interface supports insertion and extraction of VLAN tags on its
3006 own (usually in firmware) and that it should pass packets to and from
3007 the parent unaltered.
3008 .It Fl vlandev Op Ar iface
3011 pseudo device, disassociate the parent interface from it.
3012 This breaks the link between the
3014 interface and its parent,
3015 clears its VLAN Identifier, flags and its link address and shuts the interface
3019 argument is useless and hence deprecated.
3021 .Ss Virtual eXtensible LAN Parameters
3022 The following parameters are used to configure
3025 .Bl -tag -width indent
3026 .It Cm vxlanid Ar identifier
3027 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
3028 virtual network segment membership of the interface.
3029 .It Cm vxlanlocal Ar address
3030 The source address used in the encapsulating IPv4/IPv6 header.
3031 The address should already be assigned to an existing interface.
3032 When the interface is configured in unicast mode, the listening socket
3033 is bound to this address.
3034 .It Cm vxlanremote Ar address
3035 The interface can be configured in a unicast, or point-to-point, mode
3036 to create a tunnel between two hosts.
3037 This is the IP address of the remote end of the tunnel.
3038 .It Cm vxlangroup Ar address
3039 The interface can be configured in a multicast mode
3040 to create a virtual network of hosts.
3041 This is the IP multicast group address the interface will join.
3042 .It Cm vxlanlocalport Ar port
3043 The port number the interface will listen on.
3044 The default port number is 4789.
3045 .It Cm vxlanremoteport Ar port
3046 The destination port number used in the encapsulating IPv4/IPv6 header.
3047 The remote host should be listening on this port.
3048 The default port number is 4789.
3049 Note some other implementations, such as Linux,
3050 do not default to the IANA assigned port,
3051 but instead listen on port 8472.
3052 .It Cm vxlanportrange Ar low high
3053 The range of source ports used in the encapsulating IPv4/IPv6 header.
3054 The port selected within the range is based on a hash of the inner frame.
3055 A range is useful to provide entropy within the outer IP header
3056 for more effective load balancing.
3057 The default range is between the
3060 .Va net.inet.ip.portrange.first
3062 .Va net.inet.ip.portrange.last
3063 .It Cm vxlantimeout Ar timeout
3064 The maximum time, in seconds, before an entry in the forwarding table
3066 The default is 1200 seconds (20 minutes).
3067 .It Cm vxlanmaxaddr Ar max
3068 The maximum number of entries in the forwarding table.
3069 The default is 2000.
3070 .It Cm vxlandev Ar dev
3071 When the interface is configured in multicast mode, the
3073 interface is used to transmit IP multicast packets.
3074 .It Cm vxlanttl Ar ttl
3075 The TTL used in the encapsulating IPv4/IPv6 header.
3078 The source IP address and inner source Ethernet MAC address of
3079 received packets are used to dynamically populate the forwarding table.
3080 When in multicast mode, an entry in the forwarding table allows the
3081 interface to send the frame directly to the remote host instead of
3082 broadcasting the frame to the multicast group.
3083 This is the default.
3085 The forwarding table is not populated by received packets.
3087 Delete all dynamically-learned addresses from the forwarding table.
3088 .It Cm vxlanflushall
3089 Delete all addresses, including static addresses, from the forwarding table.
3092 The following parameters are used to configure
3094 protocol on an interface:
3095 .Bl -tag -width indent
3097 Set the virtual host ID.
3098 This is a required setting to initiate
3100 If the virtual host ID does not exist yet, it is created and attached to the
3101 interface, otherwise configuration of an existing vhid is adjusted.
3104 keyword is supplied along with an
3108 address, then this address is configured to be run under control of the
3110 Whenever a last address that refers to a particular vhid is removed from an
3111 interface, the vhid is automatically removed from interface and destroyed.
3112 Any other configuration parameters for the
3114 protocol should be supplied along with the
3117 Acceptable values for vhid are 1 to 255.
3118 .It Cm advbase Ar seconds
3119 Specifies the base of the advertisement interval in seconds.
3120 The acceptable values are 1 to 255.
3121 The default value is 1.
3122 .It Cm advskew Ar interval
3123 Specifies the skew to add to the base advertisement interval to
3124 make one host advertise slower than another host.
3125 It is specified in 1/256 of seconds.
3126 The acceptable values are 1 to 254.
3127 The default value is 0.
3128 .It Cm pass Ar phrase
3129 Set the authentication key to
3131 .It Cm state Ar state
3132 Forcibly change state of a given vhid.
3133 The following states are recognized:
3137 .It Cm peer Ar address
3138 Set the address to send (IPv4)
3142 Restore the default destination address for (IPv4)
3144 announcements, which is 224.0.0.18.
3145 .It Cm peer6 Ar address
3146 Set the address to send (IPv6)
3150 Restore the default destination address for (IPv4)
3152 announcements, which is ff02::12.
3155 The following environment variables affect the execution of
3157 .Bl -tag -width IFCONFIG_FORMAT
3158 .It Ev IFCONFIG_FORMAT
3159 This variable can contain a specification of the output format.
3160 See the description of the
3162 flag for more details.
3165 Assign the IPv4 address
3167 with a network mask of
3171 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3173 Add the IPv4 address
3175 with the CIDR network prefix
3179 .Dl # ifconfig em0 inet 192.0.2.45/28 alias
3181 Remove the IPv4 address
3185 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3187 Enable IPv6 functionality of the interface:
3188 .Dl # ifconfig em0 inet6 -ifdisabled
3190 Add the IPv6 address
3191 .Li 2001:DB8:DBDB::123/48
3194 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3195 Note that lower case hexadecimal IPv6 addresses are acceptable.
3197 Remove the IPv6 address added in the above example,
3200 character as shorthand for the network prefix:
3201 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 -alias
3203 Configure a single CARP redundant address on igb0, and then switch it
3205 .Bd -literal -offset indent -compact
3206 # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3207 # ifconfig igb0 vhid 1 state master
3210 Configure the interface
3212 to use 100baseTX, full duplex Ethernet media options:
3213 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3215 Label the em0 interface as an uplink:
3216 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3218 Create the software network interface
3220 .Dl # ifconfig gif1 create
3222 Destroy the software network interface
3224 .Dl # ifconfig gif1 destroy
3226 Display available wireless networks using
3228 .Dl # ifconfig wlan0 list scan
3230 Display inet and inet6 address subnet masks in CIDR notation
3231 .Dl # ifconfig -f inet:cidr,inet6:cidr
3233 Display interfaces that are up with the exception of loopback
3234 .Dl # ifconfig -a -u -G lo
3236 Display a list of interface names beloning to the wlan group:
3237 .Bd -literal -offset indent -compact
3243 Display details about the interfaces belonging to the wlan group:
3244 .Bd -literal -offset indent -compact
3245 # ifconfig -a -g wlan
3246 wlan0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3247 ether 75:4c:61:6b:7a:73
3248 inet6 fe80::4c75:636a:616e:ffd8%wlan0 prefixlen 64 scopeid 0x3
3249 inet6 2001:5761:6e64:6152:6f6d:616e:fea4:ffe2 prefixlen 64 autoconf
3250 inet 192.168.10.5 netmask 0xffffff00 broadcast 192.168.10.255
3252 ssid "Hotspot" channel 11 (2462 MHz 11g) bssid 12:34:ff:ff:43:21
3253 regdomain ETSI country DE authmode WPA2/802.11i privacy ON
3254 deftxkey UNDEF AES-CCM 2:128-bit AES-CCM 3:128-bit txpower 30 bmiss 10
3255 scanvalid 60 protmode CTS wme roaming MANUAL
3256 parent interface: iwm0
3257 media: IEEE 802.11 Wireless Ethernet DS/2Mbps mode 11g
3259 nd6 options=23<PERFORMNUD,ACCEPT_RTADV,AUTO_LINKLOCAL>
3260 wlan1: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3261 ether 00:50:69:6f:74:72
3263 ssid "" channel 2 (2417 MHz 11g)
3264 regdomain FCC country US authmode OPEN privacy OFF txpower 30 bmiss 7
3265 scanvalid 60 bgscan bgscanintvl 300 bgscanidle 250 roam:rssi 7
3266 roam:rate 5 protmode CTS wme bintval 0
3267 parent interface: rum0
3268 media: IEEE 802.11 Wireless Ethernet autoselect (autoselect)
3270 nd6 options=29<PERFORMNUD,IFDISABLED,AUTO_LINKLOCAL>
3273 Set a randomly-generated MAC address on tap0:
3274 .Dl # ifconfig tap0 ether random
3276 Messages indicating the specified interface does not exist, the
3277 requested address is unknown, or the user is not privileged and
3278 tried to alter an interface's configuration.
3300 Basic IPv6 node operation requires a link-local address on each
3301 interface configured for IPv6.
3302 Normally, such an address is automatically configured by the
3303 kernel on each interface added to the system or enabled; this behavior may
3304 be disabled by setting per-interface flag
3305 .Cm -auto_linklocal .
3306 The default value of this flag is 1 and can be disabled by using the sysctl
3308 .Va net.inet6.ip6.auto_linklocal .
3310 Do not configure IPv6 addresses with no link-local address by using
3312 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob