1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
40 .Op Fl f Ar type Ns Cm \&: Ns Ar format
57 .Op Fl f Ar type Ns Cm \&: Ns Ar format
72 .Op Fl f Ar type Ns Cm \&: Ns Ar format
76 utility is used to assign an address
77 to a network interface and/or configure
78 network interface parameters.
81 utility must be used at boot time to define the network address
82 of each interface present on a machine; it may also be used at
83 a later time to redefine an interface's address
84 or other operating parameters.
86 The following options are available:
87 .Bl -tag -width indent
89 Display information about all interfaces in the system.
93 flag may be used instead of the
97 List all the interface cloners available on the system,
98 with no additional information.
99 Use of this flag is mutually exclusive with all other flags and commands.
101 Display only the interfaces that are down.
103 .Ar type Ns Cm \&: Ns Ar format Ns
104 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
106 Control the output format of
108 The format is specified as a comma-separated list of
109 .Ar type Ns Cm \&: Ns Ar format
113 section for more information
116 The output format can also be specified via the
118 environment variable.
121 flag can be supplied multiple times.
129 .Bl -tag -width ether
131 Adjust the display of inet and inet6 addresses:
133 .Bl -tag -width default -compact
138 Fully qualified domain names
141 Unqualified hostnames
146 Adjust the display of link-level ethernet (MAC) addresses:
148 .Bl -tag -width default -compact
150 Separate address segments with a colon
152 Separate address segments with a dash
158 Adjust the display of inet address subnet masks:
160 .Bl -tag -width default -compact
162 CIDR notation, for example:
168 Dotted quad notation, for example:
171 Hexadecimal format, for example:
175 Adjust the display of inet6 address prefixes (subnet masks):
177 .Bl -tag -width default -compact
179 CIDR notation, for example:
187 Integer format, for example:
191 .It Fl G Ar groupname
192 Exclude members of the specified
199 should be specified as later override previous ones
201 may contain shell patterns in which case it should be quoted.
207 selects all interfaces.
208 .It Fl g Ar groupname
209 Limit the output to the members of the specified
214 is specified before other significant flags like, e.g.,
221 lists names of interfaces belonging to
223 Any other flags and arguments are ignored in this case.
227 should be specified as later override previous ones
229 may contain shell patterns in which case it should be quoted.
235 selects all interfaces.
237 Print keying information for the
241 For example, the values of 802.11 WEP keys and
243 passphrases will be printed, if accessible to the current user.
245 This information is not printed by default, as it may be considered
248 Display address lifetime for IPv6 addresses as time offset string.
250 List all available interfaces on the system,
251 with no other additional information.
255 is specified, only interfaces of that type will be listed.
263 will exclude loopback interfaces from the list of Ethernet interfaces.
264 This is a special case, because all the other synonyms of the
266 address family will include loopback interfaces in the list.
268 Use of this flag is mutually exclusive
269 with all other flags and commands, except for
275 Display the capability list and all
276 of the supported media for the specified interface.
278 Disable automatic loading of network interface drivers.
280 If the network interface driver is not present in the kernel then
282 will attempt to load it.
283 This flag disables this behavior.
285 Display only the interfaces that are up.
287 Get more verbose status for an interface.
290 the address is either a host name present in the host name data
293 or a IPv4 address expressed in the Internet standard
296 It is also possible to use the CIDR notation (also known as the
297 slash notation) to include the netmask.
298 That is, one can specify an address like
303 family, it is also possible to specify the prefix length using the slash
308 parameter below for more information.
313 is specified as a series of colon-separated hex digits.
314 This can be used to, for example,
315 set a new MAC address on an Ethernet interface, though the
316 mechanism used is not Ethernet specific.
320 keyword to set a randomly generated MAC address.
321 A randomly-generated MAC address might be the same as one already in use
323 Such duplications are extremely unlikely.
325 If the interface is already
326 up when the link-level address is modified,
327 it will be briefly brought down and
328 then brought back up again in order to ensure that the receive
329 filter in the underlying Ethernet hardware is properly reprogrammed.
330 .It Ar address_family
333 which affects interpretation of the remaining parameters.
334 Since an interface can receive transmissions in differing protocols
335 with different naming schemes, specifying the address family is recommended.
336 The address or protocol families currently
342 .Po with some exceptions, see
346 Default, if available.
357 Specify the address of the correspondent on the other end
358 of a point to point link.
361 parameter is a string of the form
369 utility displays the current configuration for a network interface
370 when no optional parameters are supplied.
371 If a protocol family is specified,
373 will report only the details specific to that protocol family.
375 When no arguments are given,
379 Only the super-user may modify the configuration of a network interface.
385 .Bl -tag -width indent
390 Introduced for compatibility
394 Establish an additional network address for this interface.
395 This is sometimes useful when changing network numbers, and
396 one wishes to accept packets addressed to the old interface.
397 If the address is on the same subnet as the first network address
398 for this interface, a non-conflicting netmask must be given.
403 Remove the network address specified.
404 This would be used if you incorrectly specified an alias, or it
405 was no longer needed.
406 If you have incorrectly set an NS address having the side effect
407 of specifying the host portion, removing all NS addresses will
408 allow you to respecify the host portion.
411 Specify that the address configured is an anycast address.
412 Based on the current specification,
413 only routers may configure anycast addresses.
414 Anycast address will not be used as source address of any of outgoing
417 Enable the use of the Address Resolution Protocol
420 between network level addresses and link level addresses (default).
421 This is currently implemented for mapping between Internet Protocol addresses
422 and IEEE 802 48-bit MAC addresses (Ethernet addresses).
424 Disable the use of the Address Resolution Protocol
427 If the Address Resolution Protocol is enabled,
428 the host will only reply to requests for its addresses,
429 and will never send any requests.
431 If the Address Resolution Protocol is enabled,
432 the host will perform normally,
433 sending out requests and listening for replies.
435 Enable so-called sticky ARP mode for the interface.
436 If this option is enabled on the given interface, any resolved address is
437 marked as a static one and never expires. This may be used to increase
438 security of the network by preventing ARP spoofing or to reduce latency for
439 high-performance Ethernet networks where the time needed for ARP resolution is
440 too high. Please note that a similar feature is also provided for bridges. See
441 the sticky option in the
442 .Sx Bridge Interface Parameters
443 section. Enabling this
444 option may impact techniques which rely on ARP expiration/overwriting feature
445 such as load-balancers or high-availabity solutions such as
448 Disable so-called sticky ARP mode for the interface (default).
449 Resolved addresses will expire normally respecting the kernel ARP
453 Specify the address to use to represent broadcasts to the
455 The default broadcast address is the address with a host part of all 1's.
457 Enable driver dependent debugging code; usually, this turns on
458 extra console error logging.
460 Disable driver dependent debugging code.
462 Put interface into permanently promiscuous mode.
464 Disable permanently promiscuous mode.
469 .It Cm description Ar value , Cm descr Ar value
470 Specify a description of the interface.
471 This can be used to label interfaces in situations where they may
472 otherwise be difficult to distinguish.
473 .It Cm -description , Cm -descr
474 Clear the interface description.
478 When an interface is marked
480 the system will not attempt to
481 transmit messages through that interface.
482 If possible, the interface will be reset to disable reception as well.
483 This action does not automatically disable routes using the interface.
484 .It Cm group Ar groupname
485 Assign the interface to a
487 Any interface can be in multiple groups.
489 Cloned interfaces are members of their interface family group by default.
490 For example, a PPP interface such as
492 is a member of the PPP interface family group,
494 .\" The interface(s) the default route(s) point to are members of the
497 .It Cm -group Ar groupname
498 Remove the interface from the given
503 (lowermost 64bit of an IPv6 address)
505 .It Cm fib Ar fib_number
506 Specify interface FIB.
509 is assigned to all frames or packets received on that interface.
510 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
511 the default FIB (0) irrespective of the parent interface's FIB.
512 The kernel needs to be tuned to support more than the default FIB
515 kernel configuration option, or the
518 .It Cm tunnelfib Ar fib_number
522 is assigned to all packets encapsulated by tunnel interface, e.g.,
526 .It Cm maclabel Ar label
527 If Mandatory Access Control support is enabled in the kernel,
531 .\" .Xr maclabel 7 ) .
533 If the driver supports the media selection system, set the media type
536 Some interfaces support the mutually exclusive use of one of several
537 different physical media connectors.
538 For example, a 10Mbit/s Ethernet
539 interface might support the use of either AUI
540 or twisted pair connectors.
541 Setting the media type to
543 would change the currently active connector to the AUI port.
546 would activate twisted pair.
547 Refer to the interfaces' driver
548 specific documentation or man page for a complete list of the
550 .It Cm mediaopt Ar opts
551 If the driver supports the media selection system, set the specified
552 media options on the interface.
556 is a comma delimited list of options to apply to the interface.
557 Refer to the interfaces' driver specific man page for a complete
558 list of available options.
559 .It Fl mediaopt Ar opts
560 If the driver supports the media selection system, disable the
561 specified media options on the interface.
563 If the driver supports the media selection system, set the specified
564 operating mode on the interface to
566 For IEEE 802.11 wireless interfaces that support multiple operating modes
567 this directive is used to select between 802.11a
575 Set if the driver supports TX rate limiting.
576 .It Cm inst Ar minst , Cm instance Ar minst
577 Set the media instance to
579 This is useful for devices which have multiple physical layer interfaces
582 Set the interface name to
584 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
585 If the driver supports user-configurable checksum offloading,
586 enable receive (or transmit) checksum offloading on the interface.
587 The feature can be turned on selectively per protocol family.
589 .Cm rxcsum6 , txcsum6
595 Some drivers may not be able to enable these flags independently
596 of each other, so setting one may also set the other.
597 The driver will offload as much checksum work as it can reliably
598 support, the exact level of offloading varies between drivers.
599 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
600 If the driver supports user-configurable checksum offloading,
601 disable receive (or transmit) checksum offloading on the interface.
602 The feature can be turned off selectively per protocol family.
604 .Fl rxcsum6 , txcsum6
610 These settings may not always be independent of each other.
612 If the driver supports
614 segmentation offloading, enable TSO on the interface.
615 Some drivers may not be able to support TSO for
619 packets, so they may enable only one of them.
621 If the driver supports
623 segmentation offloading, disable TSO on the interface.
624 It will always disable TSO for
629 If the driver supports
631 segmentation offloading for
635 use one of these to selectively enabled it only for one protocol family.
637 If the driver supports
639 segmentation offloading for
643 use one of these to selectively disable it only for one protocol family.
645 If the driver supports
647 large receive offloading, enable LRO on the interface.
649 If the driver supports
651 large receive offloading, disable LRO on the interface.
653 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
654 segments the encrypted record into one or more
660 If the driver supports transmit TLS offload,
661 enable transmit TLS offload on the interface.
662 Some drivers may not be able to support transmit TLS offload for
666 packets, so they may enable only one of them.
668 If the driver supports transmit TLS offload,
669 disable transmit TLS offload on the interface.
670 It will always disable TLS for
675 Enable use of rate limiting (packet pacing) for TLS offload.
677 Disable use of rate limiting for TLS offload.
679 If the driver supports extended multi-page
681 buffers, enable them on the interface.
683 If the driver supports extended multi-page
685 biffers, disable them on the interface.
686 .It Cm wol , wol_ucast , wol_mcast , wol_magic
687 Enable Wake On Lan (WOL) support, if available.
688 WOL is a facility whereby a machine in a low power state may be woken
689 in response to a received packet.
690 There are three types of packets that may wake a system:
691 ucast (directed solely to the machine's mac address),
692 mcast (directed to a broadcast or multicast address),
695 .Po unicast or multicast frames with a
698 Not all devices support WOL, those that do indicate the mechanisms
699 they support in their capabilities.
701 is a synonym for enabling all available WOL mechanisms.
704 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
705 If the driver offers user-configurable VLAN support, enable
706 reception of extended frames, tag processing in hardware,
707 frame filtering in hardware, checksum offloading, or TSO on VLAN,
709 Note that this must be configured on a physical interface associated with
714 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
715 If the driver offers user-configurable VLAN support, disable
716 reception of extended frames, tag processing in hardware,
717 frame filtering in hardware, checksum offloading, or TSO on VLAN,
719 .It Cm vxlanhwcsum , vxlanhwtso
720 If the driver offers user-configurable VXLAN support, enable inner checksum
721 offloading (receive and transmit) or TSO on VXLAN, respectively.
722 Note that this must be configured on a physical interface associated with
727 The physical interface is either the interface specified as the vxlandev
728 or the interface hosting the vxlanlocal address.
729 The driver will offload as much checksum work and TSO as it can reliably
730 support, the exact level of offloading may vary between drivers.
731 .It Fl vxlanhwcsum , vxlanhwtso
732 If the driver offers user-configurable VXLAN support, disable checksum
733 offloading (receive and transmit) or TSO on VXLAN, respectively.
735 Move the interface to the
737 specified by name or JID.
738 If the jail has a virtual network stack, the interface will disappear
739 from the current environment and become visible to the jail.
741 Reclaim the interface from the
743 specified by name or JID.
744 If the jail has a virtual network stack, the interface will disappear
745 from the jail, and become visible to the current network environment.
749 feature and disable interrupts on the interface, if driver supports
754 feature and enable interrupt mode on the interface.
756 Create the specified network pseudo-device.
757 If the interface is given without a unit number, try to create a new
758 device with an arbitrary unit number.
759 If creation of an arbitrary device is successful, the new device name is
760 printed to standard output unless the interface is renamed or destroyed
765 Destroy the specified network pseudo-device.
770 Included for Solaris compatibility.
775 Included for Solaris compatibility.
777 Set the routing metric of the interface to
780 The routing metric is used by the routing protocol
782 Higher metrics have the effect of making a route
783 less favorable; metrics are counted as additional hops
784 to the destination network or host.
786 Set the maximum transmission unit of the interface to
788 default is interface specific.
789 The MTU is used to limit the size of packets that are transmitted on an
791 Not all interfaces support setting the MTU, and some interfaces have
793 .It Cm netmask Ar mask
796 Specify how much of the address to reserve for subdividing
797 networks into sub-networks.
798 The mask includes the network part of the local address
799 and the subnet part, which is taken from the host field of the address.
800 The mask can be specified as a single hexadecimal number
803 with a dot-notation Internet address,
804 or with a pseudo-network name listed in the network table
806 The mask contains 1's for the bit positions in the 32-bit address
807 which are to be used for the network and subnet parts,
808 and 0's for the host part.
809 The mask should contain at least the standard network portion,
810 and the subnet field should be contiguous with the network
813 The netmask can also be specified in CIDR notation after the address.
816 option above for more information.
817 .It Cm prefixlen Ar len
821 bits are reserved for subdividing networks into sub-networks.
824 must be integer, and for syntactical reason it must be between 0 to 128.
825 It is almost always 64 under the current IPv6 assignment rule.
826 If the parameter is omitted, 64 is used.
828 The prefix can also be specified using the slash notation after the address.
831 option above for more information.
836 Introduced for compatibility
840 .It Cm link Op Cm 0 No - Cm 2
842 Enable special processing of the link level of the interface.
843 These three options are interface specific in actual effect, however,
844 they are in general used to select special modes of operation.
846 of this is to enable SLIP compression, or to select the connector type
847 for some Ethernet cards.
848 Refer to the man page for the specific driver
849 for more information.
851 .It Fl link Op Cm 0 No - Cm 2
853 Disable special processing at the link level with the specified interface.
855 Put the interface in monitor mode.
856 No packets are transmitted, and received packets are discarded after
860 Take the interface out of monitor mode.
861 .It Cm pcp Ar priority_code_point
864 is an 3-bit field which refers to the IEEE 802.1p
865 class of service and maps to the frame priority level.
867 Stop tagging packets on the interface w/ the priority code point.
871 This may be used to enable an interface after an
873 It happens automatically when setting the first address on an interface.
874 If the interface was reset when previously marked down,
875 the hardware will be re-initialized.
877 .Ss ICMPv6 Neighbor Discovery Protocol Parameters
878 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
879 Note that the address family keyword
882 .Bl -tag -width indent
884 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
888 .Va net.inet6.ip6.accept_rtadv
889 controls whether this flag is set by default or not.
894 Set a flag to control whether routers from which the system accepts
895 Router Advertisement messages will be added to the Default Router List
899 flag is disabled, this flag has no effect.
903 .Va net.inet6.ip6.no_radr
904 controls whether this flag is set by default or not.
908 .It Cm auto_linklocal
909 Set a flag to perform automatic link-local address configuration when
910 the interface becomes available.
914 .Va net.inet6.ip6.auto_linklocal
915 controls whether this flag is set by default or not.
916 .It Cm -auto_linklocal
920 Set the specified interface as the default route when there is no
926 Set a flag to disable all of IPv6 network communications on the
928 Note that if there are already configured IPv6
929 addresses on that interface, all of them are marked as
931 and DAD will be performed when this flag is cleared.
935 When this flag is cleared and
937 flag is enabled, automatic configuration of a link-local address is
940 Set a flag to enable Neighbor Unreachability Detection.
944 .It Cm no_prefer_iface
945 Set a flag to not honor rule 5 of source address selection in RFC 3484.
946 In practice this means the address on the outgoing interface will not be
947 preferred, effectively yielding the decision to the address selection
948 policy table, configurable with
950 .It Cm -no_prefer_iface
952 .Cm no_prefer_iface .
954 Set a flag to disable Duplicate Address Detection.
960 The following parameters are specific for IPv6 addresses.
961 Note that the address family keyword
964 .Bl -tag -width indent
966 Set the IPv6 autoconfigured address bit.
968 Clear the IPv6 autoconfigured address bit.
970 Set the IPv6 deprecated address bit.
972 Clear the IPv6 deprecated address bit.
974 Set preferred lifetime for the address.
976 Set a flag to prefer address as a candidate of the source address for
978 .It Cm -prefer_source
982 Set valid lifetime for the address.
984 .Ss IEEE 802.11 Wireless Interfaces Cloning Parameters
985 The following parameters are specific to cloning
986 IEEE 802.11 wireless interfaces with the
989 .Bl -tag -width indent
990 .It Cm wlandev Ar device
993 as the parent for the cloned device.
994 .It Cm wlanmode Ar mode
995 Specify the operating mode for this cloned device.
1013 The operating mode of a cloned interface cannot be changed.
1016 mode is actually implemented as an
1018 interface with special properties.
1019 .It Cm wlanbssid Ar bssid
1020 The 802.11 mac address to use for the bssid.
1021 This must be specified at create time for a legacy
1024 .It Cm wlanaddr Ar address
1025 The local mac address.
1026 If this is not specified then a mac address will automatically be assigned
1027 to the cloned device.
1028 Typically this address is the same as the address of the parent device
1031 parameter is specified then the driver will craft a unique address for
1032 the device (if supported).
1036 device as operating in
1040 devices have a fixed peer relationship and do not, for example, roam
1041 if their peer stops communicating.
1042 For completeness a Dynamic WDS (DWDS) interface may marked as
1045 Request a unique local mac address for the cloned device.
1046 This is only possible if the device supports multiple mac addresses.
1047 To force use of the parent's mac address use
1050 Mark the cloned interface as depending on hardware support to
1051 track received beacons.
1052 To have beacons tracked in software use
1058 can also be used to indicate no beacons should
1059 be transmitted; this can be useful when creating a WDS configuration but
1061 interfaces can only be created as companions to an access point.
1063 .Ss Cloned IEEE 802.11 Wireless Interface Parameters
1064 The following parameters are specific to IEEE 802.11 wireless interfaces
1068 .Bl -tag -width indent
1070 Enable sending and receiving AMPDU frames when using 802.11n (default).
1071 The 802.11n specification states a compliant station must be capable
1072 of receiving AMPDU frames but transmission is optional.
1075 to disable all use of AMPDU with 802.11n.
1076 For testing and/or to work around interoperability problems one can use
1080 to control use of AMPDU in one direction.
1081 .It Cm ampdudensity Ar density
1082 Set the AMPDU density parameter used when operating with 802.11n.
1083 This parameter controls the inter-packet gap for AMPDU frames.
1084 The sending device normally controls this setting but a receiving station
1085 may request wider gaps.
1088 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
1091 is treated the same as 0.
1092 .It Cm ampdulimit Ar limit
1093 Set the limit on packet size for receiving AMPDU frames when operating
1097 are 8192, 16384, 32768, and 65536 but one can also specify
1098 just the unique prefix: 8, 16, 32, 64.
1099 Note the sender may limit the size of AMPDU frames to be less
1100 than the maximum specified by the receiving station.
1102 Enable sending and receiving AMSDU frames when using 802.11n.
1103 By default AMSDU is received but not transmitted.
1106 to disable all use of AMSDU with 802.11n.
1107 For testing and/or to work around interoperability problems one can use
1111 to control use of AMSDU in one direction.
1112 .It Cm amsdulimit Ar limit
1113 Set the limit on packet size for sending and receiving AMSDU frames
1114 when operating with 802.11n.
1117 are 7935 and 3839 (bytes).
1118 Note the sender may limit the size of AMSDU frames to be less
1119 than the maximum specified by the receiving station.
1120 Note also that devices are not required to support the 7935 limit,
1121 only 3839 is required by the specification and the larger value
1122 may require more memory to be dedicated to support functionality
1123 that is rarely used.
1125 When operating as an access point, pass packets between
1126 wireless clients directly (default).
1127 To instead let them pass up through the
1128 system and be forwarded using some other mechanism, use
1130 Disabling the internal bridging
1131 is useful when traffic is to be processed with
1133 .It Cm authmode Ar mode
1134 Set the desired authentication mode in infrastructure mode.
1135 Not all adapters support all modes.
1138 .Cm none , open , shared
1144 (IEEE WPA/WPA2/802.11i).
1149 modes are only useful when using an authentication service
1150 (a supplicant for client operation or an authenticator when
1151 operating as an access point).
1152 Modes are case insensitive.
1154 Enable background scanning when operating as a station.
1155 Background scanning is a technique whereby a station associated to
1156 an access point will temporarily leave the channel to scan for
1157 neighboring stations.
1158 This allows a station to maintain a cache of nearby access points
1159 so that roaming between access points can be done without
1160 a lengthy scan operation.
1161 Background scanning is done only when a station is not busy and
1162 any outbound traffic will cancel a scan operation.
1163 Background scanning should never cause packets to be lost though
1164 there may be some small latency if outbound traffic interrupts a
1166 By default background scanning is enabled if the device is capable.
1167 To disable background scanning, use
1169 Background scanning is controlled by the
1174 Background scanning must be enabled for roaming; this is an artifact
1175 of the current implementation and may not be required in the future.
1176 .It Cm bgscanidle Ar idletime
1177 Set the minimum time a station must be idle (not transmitting or
1178 receiving frames) before a background scan is initiated.
1181 parameter is specified in milliseconds.
1182 By default a station must be idle at least 250 milliseconds before
1183 a background scan is initiated.
1184 The idle time may not be set to less than 100 milliseconds.
1185 .It Cm bgscanintvl Ar interval
1186 Set the interval at which background scanning is attempted.
1189 parameter is specified in seconds.
1190 By default a background scan is considered every 300 seconds (5 minutes).
1193 may not be set to less than 15 seconds.
1194 .It Cm bintval Ar interval
1195 Set the interval at which beacon frames are sent when operating in
1199 parameter is specified in TU's (1024 usecs).
1200 By default beacon frames are transmitted every 100 TU's.
1201 .It Cm bmissthreshold Ar count
1202 Set the number of consecutive missed beacons at which the station
1203 will attempt to roam (i.e., search for a new access point).
1206 parameter must be in the range 1 to 255; though the
1207 upper bound may be reduced according to device capabilities.
1208 The default threshold is 7 consecutive missed beacons; but
1209 this may be overridden by the device driver.
1210 Another name for the
1214 .It Cm bssid Ar address
1215 Specify the MAC address of the access point to use when operating
1216 as a station in a BSS network.
1217 This overrides any automatic selection done by the system.
1218 To disable a previously selected access point, supply
1223 This option is useful when more than one access point uses the same SSID.
1224 Another name for the
1229 Enable packet bursting.
1230 Packet bursting is a transmission technique whereby the wireless
1231 medium is acquired once to send multiple frames and the interframe
1233 This technique can significantly increase throughput by reducing
1234 transmission overhead.
1235 Packet bursting is supported by the 802.11e QoS specification
1236 and some devices that do not support QoS may still be capable.
1237 By default packet bursting is enabled if a device is capable
1239 To disable packet bursting, use
1241 .It Cm chanlist Ar channels
1242 Set the desired channels to use when scanning for access
1243 points, neighbors in an IBSS network, or looking for unoccupied
1244 channels when operating as an access point.
1245 The set of channels is specified as a comma-separated list with
1246 each element in the list representing either a single channel number or a range
1249 Channel numbers must be in the range 1 to 255 and be permissible
1250 according to the operating characteristics of the device.
1251 .It Cm channel Ar number
1252 Set a single desired channel.
1253 Channels range from 1 to 255, but the exact selection available
1254 depends on the region your adaptor was manufactured for.
1260 will clear any desired channel and, if the device is marked up,
1261 force a scan for a channel to operate on.
1262 Alternatively the frequency, in megahertz, may be specified
1263 instead of the channel number.
1265 When there are several ways to use a channel the channel
1266 number/frequency may be appended with attributes to clarify.
1267 For example, if a device is capable of operating on channel 6
1268 with 802.11n and 802.11g then one can specify that g-only use
1269 should be used by specifying
1271 Similarly the channel width can be specified by appending it
1276 specifies a 40MHz wide channel.
1277 These attributes can be combined as in:
1280 The full set of flags specified following a
1290 Atheros Dynamic Turbo mode
1299 Atheros Static Turbo mode
1301 Atheros Dynamic Turbo mode, or appended to
1307 The full set of channel widths following a
1313 5MHz aka quarter-rate channel
1315 10MHz aka half-rate channel
1317 20MHz mostly for use in specifying
1320 40MHz mostly for use in specifying
1325 a 40MHz HT channel specification may include the location
1326 of the extension channel by appending
1330 for above and below,
1333 specifies 40MHz wide HT operation
1334 with the center channel at frequency 2437 and the extension channel above.
1335 .It Cm country Ar name
1336 Set the country code to use in calculating the regulatory constraints
1338 In particular the set of available channels, how the wireless device
1339 will operation on the channels, and the maximum transmit power that
1340 can be used on a channel are defined by this setting.
1341 Country/Region codes are specified as a 2-character abbreviation
1342 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1343 e.g., "ES" and "Spain".
1344 The set of country codes are taken from
1345 .Pa /etc/regdomain.xml
1350 Note that not all devices support changing the country code from a default
1351 setting; typically stored in EEPROM.
1359 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1360 DFS embodies several facilities including detection of overlapping
1361 radar signals, dynamic transmit power control, and channel selection
1362 according to a least-congested criteria.
1363 DFS support is mandatory for some 5GHz frequencies in certain
1364 locales (e.g., ETSI).
1365 By default DFS is enabled according to the regulatory definitions
1367 .Pa /etc/regdomain.xml
1368 and the current country code, regdomain,
1370 Note the underlying device (and driver) must support radar detection
1371 for full DFS support to work.
1372 To be fully compliant with the local regulatory agency frequencies that
1373 require DFS should not be used unless it is fully supported.
1376 to disable this functionality for testing.
1378 Enable support for the 802.11d specification (default).
1379 When this support is enabled in station mode, beacon frames that advertise
1380 a country code different than the currently configured country code will
1381 cause an event to be dispatched to user applications.
1382 This event can be used by the station to adopt that country code and
1383 operate according to the associated regulatory constraints.
1384 When operating as an access point with 802.11d enabled the beacon and
1385 probe response frames transmitted will advertise the current regulatory
1387 To disable 802.11d use
1390 Enable 802.11h support including spectrum management.
1391 When 802.11h is enabled beacon and probe response frames will have
1392 the SpectrumMgt bit set in the capabilities field and
1393 country and power constraint information elements will be present.
1394 802.11h support also includes handling Channel Switch Announcements (CSA)
1395 which are a mechanism to coordinate channel changes by an access point.
1396 By default 802.11h is enabled if the device is capable.
1397 To disable 802.11h use
1399 .It Cm deftxkey Ar index
1400 Set the default key to use for transmission.
1401 Typically this is only set when using WEP encryption.
1402 Note that you must set a default transmit key
1403 for the system to know which key to use in encrypting outbound traffic.
1406 is an alias for this request; it is provided for backwards compatibility.
1407 .It Cm dtimperiod Ar period
1410 period for transmitting buffered multicast data frames when
1411 operating in ap mode.
1414 specifies the number of beacon intervals between DTIM
1415 and must be in the range 1 to 15.
1416 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1418 Enable the use of quiet IE.
1419 Hostap will use this to silence other
1420 stations to reduce interference for radar detection when
1421 operating on 5GHz frequency and doth support is enabled.
1424 to disable this functionality.
1425 .It Cm quiet_period Ar period
1428 to the number of beacon intervals between the start of regularly
1429 scheduled quiet intervals defined by Quiet element.
1430 .It Cm quiet_count Ar count
1433 to the number of TBTTs until the beacon interval during which the
1434 next quiet interval shall start.
1435 A value of 1 indicates the quiet
1436 interval will start during the beacon interval starting at the next
1438 A value 0 is reserved.
1439 .It Cm quiet_offset Ar offset
1442 to the offset of the start of the quiet interval from the TBTT
1443 specified by the Quiet count, expressed in TUs.
1446 shall be less than one beacon interval.
1447 .It Cm quiet_duration Ar dur
1450 to the duration of the Quiet interval, expressed in TUs.
1451 The value should be less than beacon interval.
1453 Enable the use of Atheros Dynamic Turbo mode when communicating with
1454 another Dynamic Turbo-capable station.
1455 Dynamic Turbo mode is an Atheros-specific mechanism by which
1456 stations switch between normal 802.11 operation and a
1458 mode in which a 40MHz wide channel is used for communication.
1459 Stations using Dynamic Turbo mode operate boosted only when the
1460 channel is free of non-dturbo stations; when a non-dturbo station
1461 is identified on the channel all stations will automatically drop
1462 back to normal operation.
1463 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1464 Note that turbo mode (dynamic or static) is only allowed on some
1465 channels depending on the regulatory constraints; use the
1467 command to identify the channels where turbo mode may be used.
1468 To disable Dynamic Turbo mode use
1471 Enable Dynamic WDS (DWDS) support.
1472 DWDS is a facility by which 4-address traffic can be carried between
1473 stations operating in infrastructure mode.
1474 A station first associates to an access point and authenticates using
1475 normal procedures (e.g., WPA).
1476 Then 4-address frames are passed to carry traffic for stations
1477 operating on either side of the wireless link.
1478 DWDS extends the normal WDS mechanism by leveraging existing security
1479 protocols and eliminating static binding.
1481 When DWDS is enabled on an access point 4-address frames received from
1482 an authorized station will generate a
1486 This event should be used to create a WDS interface that is bound
1487 to the remote station (and usually plumbed into a bridge).
1488 Once the WDS interface is up and running 4-address traffic then logically
1489 flows through that interface.
1491 When DWDS is enabled on a station, traffic with a destination address
1492 different from the peer station are encapsulated in a 4-address frame
1493 and transmitted to the peer.
1494 All 4-address traffic uses the security information of the stations
1495 (e.g., cryptographic keys).
1496 A station is associated using 802.11n facilities may transport
1497 4-address traffic using these same mechanisms; this depends on available
1498 resources and capabilities of the device.
1499 The DWDS implementation guards against layer 2 routing loops of
1502 Enable the use of Atheros Fast Frames when communicating with
1503 another Fast Frames-capable station.
1504 Fast Frames are an encapsulation technique by which two 802.3
1505 frames are transmitted in a single 802.11 frame.
1506 This can noticeably improve throughput but requires that the
1507 receiving station understand how to decapsulate the frame.
1508 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1509 protocol extension so enabling use is safe when communicating with
1510 non-Atheros devices.
1511 By default, use of fast frames is enabled if the device is capable.
1512 To explicitly disable fast frames, use
1514 .It Cm fragthreshold Ar length
1515 Set the threshold for which transmitted frames are broken into fragments.
1518 argument is the frame size in bytes and must be in the range 256 to 2346.
1526 disables transmit fragmentation.
1527 Not all adapters honor the fragmentation threshold.
1529 When operating as an access point, do not broadcast the SSID
1530 in beacon frames or respond to probe request frames unless
1531 they are directed to the ap (i.e., they include the ap's SSID).
1532 By default, the SSID is included in beacon frames and
1533 undirected probe request frames are answered.
1534 To re-enable the broadcast of the SSID etc., use
1537 Enable use of High Throughput (HT) when using 802.11n (default).
1538 The 802.11n specification includes mechanisms for operation
1539 on 20MHz and 40MHz wide channels using different signalling mechanisms
1540 than specified in 802.11b, 802.11g, and 802.11a.
1541 Stations negotiate use of these facilities, termed HT20 and HT40,
1542 when they associate.
1543 To disable all use of 802.11n use
1545 To disable use of HT20 (e.g., to force only HT40 use) use
1547 To disable use of HT40 use
1550 HT configuration is used to
1553 when several choices are available.
1554 For example, if a station associates to an 11n-capable access point
1555 it controls whether the station uses legacy operation, HT20, or HT40.
1556 When an 11n-capable device is setup as an access point and
1557 Auto Channel Selection is used to locate a channel to operate on,
1558 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1559 on the selected channel.
1560 If a fixed channel is specified for a station then HT configuration can
1561 be given as part of the channel specification; e.g., 6:ht/20 to setup
1562 HT20 operation on channel 6.
1564 Enable use of compatibility support for pre-802.11n devices (default).
1565 The 802.11n protocol specification went through several incompatible iterations.
1566 Some vendors implemented 11n support to older specifications that
1567 will not interoperate with a purely 11n-compliant station.
1568 In particular the information elements included in management frames
1569 for old devices are different.
1570 When compatibility support is enabled both standard and compatible data
1572 Stations that associate using the compatibility mechanisms are flagged
1575 To disable compatibility support use
1577 .It Cm htprotmode Ar technique
1578 For interfaces operating in 802.11n, use the specified
1580 for protecting HT frames in a mixed legacy/HT network.
1581 The set of valid techniques is
1586 Technique names are case insensitive.
1588 Enable inactivity processing for stations associated to an
1589 access point (default).
1590 When operating as an access point the 802.11 layer monitors
1591 the activity of each associated station.
1592 When a station is inactive for 5 minutes it will send several
1594 to see if the station is still present.
1595 If no response is received then the station is deauthenticated.
1596 Applications that prefer to handle this work can disable this
1600 Set the location to use in calculating regulatory constraints.
1601 The location is also advertised in beacon and probe response frames
1602 when 802.11d is enabled with
1611 Display the list of channels available for use taking into account
1612 any restrictions set with the
1615 See the description of
1617 for more information.
1619 Display the adaptor's capabilities, including the operating
1622 Display the list of channels available for use.
1623 Channels are shown with their IEEE channel number, equivalent
1624 frequency, and usage modes.
1625 Channels identified as
1630 Channels identified as
1632 may be used only for Atheros' Static Turbo mode
1634 . Cm mediaopt turbo ) .
1635 Channels marked with a
1637 have a regulatory constraint that they be passively scanned.
1638 This means a station is not permitted to transmit on the channel until
1639 it identifies the channel is being used for 802.11 communication;
1640 typically by hearing a beacon frame from an access point operating
1643 is another way of requesting this information.
1644 By default a compacted list of channels is displayed; if the
1646 option is specified then all channels are shown.
1647 .It Cm list countries
1648 Display the set of country codes and regulatory domains that can be
1649 used in regulatory configuration.
1651 Display the current MAC Access Control List state.
1652 Each address is prefixed with a character that indicates the
1653 current policy applied to it:
1655 indicates the address is allowed access,
1657 indicates the address is denied access,
1659 indicates the address is present but the current policy open
1660 (so the ACL is not consulted).
1662 Displays the mesh routing table, used for forwarding packets on a mesh
1664 .It Cm list regdomain
1665 Display the current regulatory settings including the available channels
1666 and transmit power caps.
1668 Display the parameters that govern roaming operation.
1670 Display the parameters that govern transmit operation.
1672 Display the transmit power caps for each channel.
1674 Display the access points and/or ad-hoc neighbors
1675 located in the vicinity.
1676 This information may be updated automatically by the adapter
1679 request or through background scanning.
1680 Depending on the capabilities of the stations the following
1681 flags (capability codes) can be included in the output:
1688 Poll request capability.
1690 DSSS/OFDM capability.
1692 Extended Service Set (ESS).
1693 Indicates that the station is part of an infrastructure network
1694 rather than an IBSS/ad-hoc network.
1696 Independent Basic Service Set (IBSS).
1697 Indicates that the station is part of an ad-hoc network
1698 rather than an ESS network.
1701 The station requires authentication and encryption
1702 for all data frames exchanged within the BSS using cryptographic means
1703 such as WEP, TKIP, or AES-CCMP.
1705 Robust Secure Network (RSN).
1708 Indicates that the network is using short preambles,
1709 defined in 802.11b High Rate/DSSS PHY,
1710 and utilizes a 56 bit sync field
1711 rather than the 128 bit field used in long preamble mode.
1712 Short preambles are used to optionally
1713 improve throughput performance with 802.11g and 802.11b.
1715 Pollable capability.
1717 Short slot time capability.
1718 Indicates that the 802.11g network is using a short slot time
1719 because there are no legacy (802.11b) stations present.
1722 By default interesting information elements captured from the neighboring
1723 stations are displayed at the end of each row.
1724 Possible elements include:
1726 (station supports WME),
1728 (station supports WPA),
1730 (station supports WPS),
1732 (station supports 802.11i/RSN),
1734 (station supports 802.11n/HT communication),
1736 (station supports Atheros protocol extensions),
1738 (station supports unknown vendor-specific extensions).
1741 flag is used all the information elements and their
1742 contents will be shown.
1745 flag also enables display of long SSIDs.
1748 command is another way of requesting this information.
1750 When operating as an access point display the stations that are
1751 currently associated.
1752 When operating in ad-hoc mode display stations identified as
1753 neighbors in the IBSS.
1754 When operating in mesh mode display stations identified as
1755 neighbors in the MBSS.
1756 When operating in station mode display the access point.
1757 Capabilities advertised by the stations are described under
1761 The following flags can be included in the output:
1765 Indicates that the station is permitted to send/receive data frames.
1767 Extended Rate Phy (ERP).
1768 Indicates that the station is operating in an 802.11g network
1769 using extended transmit rates.
1771 High Throughput (HT).
1772 Indicates that the station is using HT transmit rates.
1775 follows immediately after then the station associated
1776 using deprecated mechanisms supported only when
1781 Indicates that the station is operating in power save mode.
1783 Quality of Service (QoS).
1784 Indicates that the station is using QoS encapsulation for
1786 QoS encapsulation is enabled only when WME mode is enabled.
1788 Short GI in HT 40MHz mode enabled.
1791 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1793 Transitional Security Network (TSN).
1794 Indicates that the station associated using TSN; see also
1798 Wi-Fi Protected Setup (WPS).
1799 Indicates that the station associated using WPS.
1801 Short GI in HT 20MHz mode enabled.
1804 By default information elements received from associated stations
1805 are displayed in a short form; the
1807 flag causes this information to be displayed symbolically.
1809 Display the current channel parameters to use when operating in WME mode.
1812 option is specified then both channel and BSS parameters are displayed
1813 for each AC (first channel, then BSS).
1814 When WME mode is enabled for an adaptor this information will be
1815 displayed with the regular status; this command is mostly useful
1816 for examining parameters when WME mode is disabled.
1817 See the description of the
1819 directive for information on the various parameters.
1820 .It Cm maxretry Ar count
1821 Set the maximum number of tries to use in sending unicast frames.
1822 The default setting is 6 but drivers may override this with a value
1824 .It Cm mcastrate Ar rate
1825 Set the rate for transmitting multicast/broadcast frames.
1826 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1827 This rate should be valid for the current operating conditions;
1828 if an invalid rate is specified drivers are free to chose an
1830 .It Cm mgtrate Ar rate
1831 Set the rate for transmitting management and/or control frames.
1832 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1834 Set the location to use in calculating regulatory constraints.
1835 The location is also advertised in beacon and probe response frames
1836 when 802.11d is enabled with
1845 Enable powersave operation.
1846 When operating as a client, the station will conserve power by
1847 periodically turning off the radio and listening for
1848 messages from the access point telling it there are packets waiting.
1849 The station must then retrieve the packets.
1850 Not all devices support power save operation as a client.
1851 The 802.11 specification requires that all access points support
1852 power save but some drivers do not.
1855 to disable powersave operation when operating as a client.
1856 .It Cm powersavesleep Ar sleep
1857 Set the desired max powersave sleep time in TU's (1024 usecs).
1858 By default the max powersave sleep time is 100 TU's.
1859 .It Cm protmode Ar technique
1860 For interfaces operating in 802.11g, use the specified
1862 for protecting OFDM frames in a mixed 11b/11g network.
1863 The set of valid techniques is
1869 Technique names are case insensitive.
1870 Not all devices support
1872 as a protection technique.
1874 When operating as an access point in 802.11g mode allow only
1875 11g-capable stations to associate (11b-only stations are not
1876 permitted to associate).
1877 To allow both 11g and 11b-only stations to associate, use
1880 When operating as an access point in 802.11n mode allow only
1881 HT-capable stations to associate (legacy stations are not
1882 permitted to associate).
1883 To allow both HT and legacy stations to associate, use
1885 .It Cm regdomain Ar sku
1886 Set the regulatory domain to use in calculating the regulatory constraints
1888 In particular the set of available channels, how the wireless device
1889 will operation on the channels, and the maximum transmit power that
1890 can be used on a channel are defined by this setting.
1891 Regdomain codes (SKU's) are taken from
1892 .Pa /etc/regdomain.xml
1897 Note that not all devices support changing the regdomain from a default
1898 setting; typically stored in EEPROM.
1906 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1908 Note that RIFS must be supported by both the station and access point
1912 .It Cm roam:rate Ar rate
1913 Set the threshold for controlling roaming when operating in a BSS.
1916 parameter specifies the transmit rate in megabits
1917 at which roaming should be considered.
1918 If the current transmit rate drops below this setting and background scanning
1919 is enabled, then the system will check if a more desirable access point is
1920 available and switch over to it.
1921 The current scan cache contents are used if they are considered
1922 valid according to the
1924 parameter; otherwise a background scan operation is triggered before
1925 any selection occurs.
1926 Each channel type has a separate rate threshold; the default values are:
1927 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1928 .It Cm roam:rssi Ar rssi
1929 Set the threshold for controlling roaming when operating in a BSS.
1932 parameter specifies the receive signal strength in dBm units
1933 at which roaming should be considered.
1934 If the current rssi drops below this setting and background scanning
1935 is enabled, then the system will check if a more desirable access point is
1936 available and switch over to it.
1937 The current scan cache contents are used if they are considered
1938 valid according to the
1940 parameter; otherwise a background scan operation is triggered before
1941 any selection occurs.
1942 Each channel type has a separate rssi threshold; the default values are
1944 .It Cm roaming Ar mode
1945 When operating as a station, control how the system will
1946 behave when communication with the current access point
1950 argument may be one of
1952 (leave it to the hardware device to decide),
1954 (handle either in the device or the operating system\[em]as appropriate),
1956 (do nothing until explicitly instructed).
1957 By default, the device is left to handle this if it is
1958 capable; otherwise, the operating system will automatically
1959 attempt to reestablish communication.
1960 Manual mode is used by applications such as
1961 .Xr wpa_supplicant 8
1962 that want to control the selection of an access point.
1963 .It Cm rtsthreshold Ar length
1964 Set the threshold for which
1965 transmitted frames are preceded by transmission of an
1971 is the frame size in bytes and must be in the range 1 to 2346.
1979 disables transmission of RTS frames.
1980 Not all adapters support setting the RTS threshold.
1982 Initiate a scan of neighboring stations, wait for it to complete, and
1983 display all stations found.
1984 Only the super-user can initiate a scan.
1987 for information on the display.
1988 By default a background scan is done; otherwise a foreground
1989 scan is done and the station may roam to a different access point.
1992 request can be used to show recent scan results without
1993 initiating a new scan.
1994 .It Cm scanvalid Ar threshold
1995 Set the maximum time the scan cache contents are considered valid;
1996 i.e., will be used without first triggering a scan operation to
2000 parameter is specified in seconds and defaults to 60 seconds.
2001 The minimum setting for
2004 One should take care setting this threshold; if it is set too low
2005 then attempts to roam to another access point may trigger unnecessary
2006 background scan operations.
2008 Enable use of Short Guard Interval when operating in 802.11n
2010 NB: this currently enables Short GI on both HT40 and HT20 channels.
2011 To disable Short GI use
2014 Enable use of Static Spatial Multiplexing Power Save (SMPS)
2015 when operating in 802.11n.
2016 A station operating with Static SMPS maintains only a single
2017 receive chain active (this can significantly reduce power consumption).
2021 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
2022 when operating in 802.11n.
2023 A station operating with Dynamic SMPS maintains only a single
2024 receive chain active but switches to multiple receive chains when it
2025 receives an RTS frame (this can significantly reduce power consumption).
2026 Note that stations cannot distinguish between RTS/CTS intended to
2027 enable multiple receive chains and those used for other purposes.
2031 Set the desired Service Set Identifier (aka network name).
2032 The SSID is a string up to 32 characters
2033 in length and may be specified as either a normal string or in
2034 hexadecimal when preceded by
2036 Additionally, the SSID may be cleared by setting it to
2038 .It Cm tdmaslot Ar slot
2039 When operating with TDMA, use the specified
2044 is a number between 0 and the maximum number of slots in the BSS.
2045 Note that a station configured as slot 0 is a master and
2046 will broadcast beacon frames advertising the BSS;
2047 stations configured to use other slots will always
2048 scan to locate a master before they ever transmit.
2052 .It Cm tdmaslotcnt Ar cnt
2053 When operating with TDMA, setup a BSS with
2056 The slot count may be at most 8.
2057 The current implementation is only tested with two stations
2058 (i.e., point to point applications).
2059 This setting is only meaningful when a station is configured as slot 0;
2060 other stations adopt this setting from the BSS they join.
2064 .It Cm tdmaslotlen Ar len
2065 When operating with TDMA, setup a BSS such that each station has a slot
2068 The slot length must be at least 150 microseconds (1/8 TU)
2069 and no more than 65 milliseconds.
2070 Note that setting too small a slot length may result in poor channel
2071 bandwidth utilization due to factors such as timer granularity and
2073 This setting is only meaningful when a station is configured as slot 0;
2074 other stations adopt this setting from the BSS they join.
2077 is set to 10 milliseconds.
2078 .It Cm tdmabintval Ar intval
2079 When operating with TDMA, setup a BSS such that beacons are transmitted every
2081 superframes to synchronize the TDMA slot timing.
2082 A superframe is defined as the number of slots times the slot length; e.g.,
2083 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
2084 The beacon interval may not be zero.
2087 causes the timers to be resynchronized more often; this can be help if
2088 significant timer drift is observed.
2093 When operating as an access point with WPA/802.11i allow legacy
2094 stations to associate using static key WEP and open authentication.
2095 To disallow legacy station use of WEP, use
2097 .It Cm txpower Ar power
2098 Set the power used to transmit frames.
2101 argument is specified in .5 dBm units.
2102 Out of range values are truncated.
2103 Typically only a few discrete power settings are available and
2104 the driver will use the setting closest to the specified value.
2105 Not all adapters support changing the transmit power.
2106 .It Cm ucastrate Ar rate
2107 Set a fixed rate for transmitting unicast frames.
2108 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
2109 This rate should be valid for the current operating conditions;
2110 if an invalid rate is specified drivers are free to chose an
2112 .It Cm wepmode Ar mode
2113 Set the desired WEP mode.
2114 Not all adapters support all modes.
2115 The set of valid modes is
2121 mode explicitly tells the adaptor to allow association with access
2122 points which allow both encrypted and unencrypted traffic.
2125 means that the access point must only allow encrypted connections.
2128 is generally another name for
2130 Modes are case insensitive.
2131 .It Cm weptxkey Ar index
2132 Set the WEP key to be used for transmission.
2133 This is the same as setting the default transmission key with
2135 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
2136 Set the selected WEP key.
2139 is not given, key 1 is set.
2140 A WEP key will be either 5 or 13
2141 characters (40 or 104 bits) depending on the local network and the
2142 capabilities of the adaptor.
2143 It may be specified either as a plain
2144 string or as a string of hexadecimal digits preceded by
2146 For maximum portability, hex keys are recommended;
2147 the mapping of text keys to WEP encryption is usually driver-specific.
2148 In particular, the Windows drivers do this mapping differently to
2150 A key may be cleared by setting it to
2152 If WEP is supported then there are at least four keys.
2153 Some adapters support more than four keys.
2154 If that is the case, then the first four keys
2155 (1-4) will be the standard temporary keys and any others will be adaptor
2156 specific keys such as permanent keys stored in NVRAM.
2158 Note that you must set a default transmit key with
2160 for the system to know which key to use in encrypting outbound traffic.
2162 Enable Wireless Multimedia Extensions (WME) support, if available,
2163 for the specified interface.
2164 WME is a subset of the IEEE 802.11e standard to support the
2165 efficient communication of realtime and multimedia data.
2166 To disable WME support, use
2168 Another name for this parameter is
2171 The following parameters are meaningful only when WME support is in use.
2172 Parameters are specified per-AC (Access Category) and
2173 split into those that are used by a station when acting
2174 as an access point and those for client stations in the BSS.
2175 The latter are received from the access point and may not be changed
2177 The following Access Categories are recognized:
2179 .Bl -tag -width ".Cm AC_BK" -compact
2183 best effort delivery,
2198 AC parameters are case-insensitive.
2199 Traffic classification is done in the operating system using the
2200 vlan priority associated with data frames or the
2201 ToS (Type of Service) indication in IP-encapsulated frames.
2202 If neither information is present, traffic is assigned to the
2203 Best Effort (BE) category.
2204 .Bl -tag -width indent
2206 Set the ACK policy for QoS transmissions by the local station;
2207 this controls whether or not data frames transmitted by a station
2208 require an ACK response from the receiving station.
2209 To disable waiting for an ACK use
2211 This parameter is applied only to the local station.
2213 Enable the Admission Control Mandatory (ACM) mechanism
2214 for transmissions by the local station.
2215 To disable the ACM use
2217 On stations in a BSS this parameter is read-only and indicates
2218 the setting received from the access point.
2219 NB: ACM is not supported right now.
2220 .It Cm aifs Ar ac Ar count
2221 Set the Arbitration Inter Frame Spacing (AIFS)
2222 channel access parameter to use for transmissions
2223 by the local station.
2224 On stations in a BSS this parameter is read-only and indicates
2225 the setting received from the access point.
2226 .It Cm cwmin Ar ac Ar count
2227 Set the CWmin channel access parameter to use for transmissions
2228 by the local station.
2229 On stations in a BSS this parameter is read-only and indicates
2230 the setting received from the access point.
2231 .It Cm cwmax Ar ac Ar count
2232 Set the CWmax channel access parameter to use for transmissions
2233 by the local station.
2234 On stations in a BSS this parameter is read-only and indicates
2235 the setting received from the access point.
2236 .It Cm txoplimit Ar ac Ar limit
2237 Set the Transmission Opportunity Limit channel access parameter
2238 to use for transmissions by the local station.
2239 This parameter defines an interval of time when a WME station
2240 has the right to initiate transmissions onto the wireless medium.
2241 On stations in a BSS this parameter is read-only and indicates
2242 the setting received from the access point.
2243 .It Cm bss:aifs Ar ac Ar count
2244 Set the AIFS channel access parameter to send to stations in a BSS.
2245 This parameter is meaningful only when operating in ap mode.
2246 .It Cm bss:cwmin Ar ac Ar count
2247 Set the CWmin channel access parameter to send to stations in a BSS.
2248 This parameter is meaningful only when operating in ap mode.
2249 .It Cm bss:cwmax Ar ac Ar count
2250 Set the CWmax channel access parameter to send to stations in a BSS.
2251 This parameter is meaningful only when operating in ap mode.
2252 .It Cm bss:txoplimit Ar ac Ar limit
2253 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2254 This parameter is meaningful only when operating in ap mode.
2257 Enable Wireless Privacy Subscriber support.
2258 Note that WPS support requires a WPS-capable supplicant.
2259 To disable this function use
2262 .Ss MAC-Based Access Control List Parameters
2263 The following parameters support an optional access control list
2264 feature available with some adapters when operating in ap mode; see
2266 This facility allows an access point to accept/deny association
2267 requests based on the MAC address of the station.
2268 Note that this feature does not significantly enhance security
2269 as MAC address spoofing is easy to do.
2270 .Bl -tag -width indent
2271 .It Cm mac:add Ar address
2272 Add the specified MAC address to the database.
2273 Depending on the policy setting association requests from the
2274 specified station will be allowed or denied.
2276 Set the ACL policy to permit association only by
2277 stations registered in the database.
2278 .It Cm mac:del Ar address
2279 Delete the specified MAC address from the database.
2281 Set the ACL policy to deny association only by
2282 stations registered in the database.
2283 .It Cm mac:kick Ar address
2284 Force the specified station to be deauthenticated.
2285 This typically is done to block a station after updating the
2288 Set the ACL policy to allow all stations to associate.
2290 Delete all entries in the database.
2292 Set the ACL policy to permit association only by
2293 stations approved by a RADIUS server.
2294 Note that this feature requires the
2296 program be configured to do the right thing
2297 as it handles the RADIUS processing
2298 (and marks stations as authorized).
2300 .Ss Mesh Mode Wireless Interface Parameters
2301 The following parameters are related to a wireless interface operating in mesh
2303 .Bl -tag -width indent
2304 .It Cm meshid Ar meshid
2305 Set the desired Mesh Identifier.
2306 The Mesh ID is a string up to 32 characters in length.
2307 A mesh interface must have a Mesh Identifier specified
2308 to reach an operational state.
2309 .It Cm meshttl Ar ttl
2312 for mesh forwarded packets;
2313 this is the number of hops a packet may be forwarded before
2315 The default setting for
2319 Enable or disable peering with neighbor mesh stations.
2320 Stations must peer before any data packets can be exchanged.
2325 Enable or disable forwarding packets by a mesh interface.
2330 This attribute specifies whether or not the mesh STA activates mesh gate
2335 .It Cm meshmetric Ar protocol
2338 as the link metric protocol used on a mesh network.
2339 The default protocol is called
2341 The mesh interface will restart after changing this setting.
2342 .It Cm meshpath Ar protocol
2345 as the path selection protocol used on a mesh network.
2346 The only available protocol at the moment is called
2348 (Hybrid Wireless Mesh Protocol).
2349 The mesh interface will restart after changing this setting.
2350 .It Cm hwmprootmode Ar mode
2351 Stations on a mesh network can operate as
2353 Root nodes try to find paths to all mesh nodes and advertise themselves
2355 When there is a root mesh node on a network, other mesh nodes can setup
2356 paths between themselves faster because they can use the root node
2357 to find the destination.
2358 This path may not be the best, but on-demand
2359 routing will eventually find the best path.
2360 The following modes are recognized:
2362 .Bl -tag -width ".Cm PROACTIVE" -compact
2366 Send broadcast path requests every two seconds.
2367 Nodes on the mesh without a path to this root mesh station with try to
2368 discover a path to us.
2370 Send broadcast path requests every two seconds and every node must reply
2371 with a path reply even if it already has a path to this root mesh station.
2373 Send broadcast root announcement (RANN) frames.
2374 Nodes on the mesh without a path to this root mesh station with try to
2375 discover a path to us.
2381 .It Cm hwmpmaxhops Ar cnt
2382 Set the maximum number of hops allowed in an HMWP path to
2384 The default setting for
2388 .Ss Compatibility Parameters
2389 The following parameters are for compatibility with other systems:
2390 .Bl -tag -width indent
2392 Another name for the
2398 .It Cm stationname Ar name
2399 Set the name of this station.
2400 The station name is not part of the IEEE 802.11
2401 protocol though some interfaces support it.
2403 seems to be meaningful to identical or virtually identical equipment.
2404 Setting the station name is identical in syntax to setting the SSID.
2411 Another way of saying
2417 Another way of saying
2423 Another way of saying:
2424 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2430 .Ar n : k1 , k2 , k3 , k4
2433 Another way of saying
2434 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2439 Another way of saying
2445 .Ss Bridge Interface Parameters
2446 The following parameters are specific to bridge interfaces:
2447 .Bl -tag -width indent
2448 .It Cm addm Ar interface
2449 Add the interface named by
2451 as a member of the bridge.
2452 The interface is put into promiscuous mode
2453 so that it can receive every packet sent on the network.
2454 .It Cm deletem Ar interface
2455 Remove the interface named by
2458 Promiscuous mode is disabled on the interface when
2459 it is removed from the bridge.
2460 .It Cm maxaddr Ar size
2461 Set the size of the bridge address cache to
2463 The default is 2000 entries.
2464 .It Cm timeout Ar seconds
2465 Set the timeout of address cache entries to
2470 is zero, then address cache entries will not be expired.
2471 The default is 1200 seconds.
2473 Display the addresses that have been learned by the bridge.
2474 .It Cm static Ar interface-name Ar address
2475 Add a static entry into the address cache pointing to
2476 .Ar interface-name .
2477 Static entries are never aged out of the cache or re-placed, even if the
2478 address is seen on a different interface.
2479 .It Cm deladdr Ar address
2482 from the address cache.
2484 Delete all dynamically-learned addresses from the address cache.
2486 Delete all addresses, including static addresses, from the address cache.
2487 .It Cm discover Ar interface
2488 Mark an interface as a
2491 When the bridge has no address cache entry
2492 (either dynamic or static)
2493 for the destination address of a packet,
2494 the bridge will forward the packet to all
2495 member interfaces marked as
2497 This is the default for all interfaces added to a bridge.
2498 .It Cm -discover Ar interface
2501 attribute on a member interface.
2502 For packets without the
2504 attribute, the only packets forwarded on the interface are broadcast
2505 or multicast packets and packets for which the destination address
2506 is known to be on the interface's segment.
2507 .It Cm learn Ar interface
2508 Mark an interface as a
2511 When a packet arrives on such an interface, the source
2512 address of the packet is entered into the address cache as being a
2513 destination address on the interface's segment.
2514 This is the default for all interfaces added to a bridge.
2515 .It Cm -learn Ar interface
2518 attribute on a member interface.
2519 .It Cm sticky Ar interface
2520 Mark an interface as a
2523 Dynamically learned address entries are treated at static once entered into
2525 Sticky entries are never aged out of the cache or replaced, even if the
2526 address is seen on a different interface.
2527 .It Cm -sticky Ar interface
2530 attribute on a member interface.
2531 .It Cm private Ar interface
2532 Mark an interface as a
2535 A private interface does not forward any traffic to any other port that is also
2536 a private interface.
2537 .It Cm -private Ar interface
2540 attribute on a member interface.
2541 .It Cm span Ar interface
2542 Add the interface named by
2544 as a span port on the bridge.
2545 Span ports transmit a copy of every frame received by the bridge.
2546 This is most useful for snooping a bridged network passively on
2547 another host connected to one of the span ports of the bridge.
2548 .It Cm -span Ar interface
2549 Delete the interface named by
2551 from the list of span ports of the bridge.
2552 .It Cm stp Ar interface
2553 Enable Spanning Tree protocol on
2557 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2558 Spanning Tree is used to detect and remove loops in a network topology.
2559 .It Cm -stp Ar interface
2560 Disable Spanning Tree protocol on
2562 This is the default for all interfaces added to a bridge.
2563 .It Cm edge Ar interface
2567 An edge port connects directly to end stations cannot create bridging
2568 loops in the network, this allows it to transition straight to forwarding.
2569 .It Cm -edge Ar interface
2570 Disable edge status on
2572 .It Cm autoedge Ar interface
2575 to automatically detect edge status.
2576 This is the default for all interfaces added to a bridge.
2577 .It Cm -autoedge Ar interface
2578 Disable automatic edge status on
2580 .It Cm ptp Ar interface
2583 as a point to point link.
2584 This is required for straight transitions to forwarding and
2585 should be enabled on a direct link to another RSTP capable switch.
2586 .It Cm -ptp Ar interface
2587 Disable point to point link status on
2589 This should be disabled for a half duplex link and for an interface
2590 connected to a shared network segment,
2591 like a hub or a wireless network.
2592 .It Cm autoptp Ar interface
2593 Automatically detect the point to point status on
2595 by checking the full duplex link status.
2596 This is the default for interfaces added to the bridge.
2597 .It Cm -autoptp Ar interface
2598 Disable automatic point to point link detection on
2600 .It Cm maxage Ar seconds
2601 Set the time that a Spanning Tree protocol configuration is valid.
2602 The default is 20 seconds.
2603 The minimum is 6 seconds and the maximum is 40 seconds.
2604 .It Cm fwddelay Ar seconds
2605 Set the time that must pass before an interface begins forwarding
2606 packets when Spanning Tree is enabled.
2607 The default is 15 seconds.
2608 The minimum is 4 seconds and the maximum is 30 seconds.
2609 .It Cm hellotime Ar seconds
2610 Set the time between broadcasting of Spanning Tree protocol
2611 configuration messages.
2612 The hello time may only be changed when operating in legacy stp mode.
2613 The default is 2 seconds.
2614 The minimum is 1 second and the maximum is 2 seconds.
2615 .It Cm priority Ar value
2616 Set the bridge priority for Spanning Tree.
2617 The default is 32768.
2618 The minimum is 0 and the maximum is 61440.
2619 .It Cm proto Ar value
2620 Set the Spanning Tree protocol.
2621 The default is rstp.
2622 The available options are stp and rstp.
2623 .It Cm holdcnt Ar value
2624 Set the transmit hold count for Spanning Tree.
2625 This is the number of packets transmitted before being rate limited.
2627 The minimum is 1 and the maximum is 10.
2628 .It Cm ifpriority Ar interface Ar value
2629 Set the Spanning Tree priority of
2634 The minimum is 0 and the maximum is 240.
2635 .It Cm ifpathcost Ar interface Ar value
2636 Set the Spanning Tree path cost of
2640 The default is calculated from the link speed.
2641 To change a previously selected path cost back to automatic, set the
2643 The minimum is 1 and the maximum is 200000000.
2644 .It Cm ifmaxaddr Ar interface Ar size
2645 Set the maximum number of hosts allowed from an interface, packets with unknown
2646 source addresses are dropped until an existing host cache entry expires or is
2648 Set to 0 to disable.
2650 .Ss Link Aggregation and Link Failover Parameters
2651 The following parameters are specific to lagg interfaces:
2652 .Bl -tag -width indent
2653 .It Cm laggtype Ar type
2654 When creating a lagg interface the type can be specified as either
2658 If not specified ethernet is the default lagg type.
2659 .It Cm laggport Ar interface
2660 Add the interface named by
2662 as a port of the aggregation interface.
2663 .It Cm -laggport Ar interface
2664 Remove the interface named by
2666 from the aggregation interface.
2667 .It Cm laggproto Ar proto
2668 Set the aggregation protocol.
2671 The available options are
2679 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2680 Set the packet layers to hash for aggregation protocols which load balance.
2683 The options can be combined using commas.
2685 .Bl -tag -width ".Cm l2" -compact
2687 src/dst mac address and optional vlan number.
2689 src/dst address for IPv4 or IPv6.
2691 src/dst port for TCP/UDP/SCTP.
2694 Enable local hash computation for RSS hash on the interface.
2699 modes will use the RSS hash from the network card if available
2700 to avoid computing one, this may give poor traffic distribution
2701 if the hash is invalid or uses less of the protocol header information.
2703 disables use of RSS hash from the network card.
2704 The default value can be set via the
2705 .Va net.link.lagg.default_use_flowid
2716 Use the RSS hash from the network card if available.
2717 .It Cm flowid_shift Ar number
2718 Set a shift parameter for RSS local hash computation.
2719 Hash is calculated by using flowid bits in a packet header mbuf
2720 which are shifted by the number of this parameter.
2722 Enable selection of egress ports based on the native
2724 domain for the packets being transmitted.
2725 This is currently only implemented for lacp mode.
2728 hardware, running a kernel compiled with the
2730 option, and when interfaces from multiple
2732 domains are ports of the aggregation interface.
2734 Disable selection of egress ports based on the native
2736 domain for the packets being transmitted.
2737 .It Cm lacp_fast_timeout
2738 Enable lacp fast-timeout on the interface.
2739 .It Cm -lacp_fast_timeout
2740 Disable lacp fast-timeout on the interface.
2742 Enable lacp strict compliance on the interface.
2743 The default value can be set via the
2744 .Va net.link.lagg.lacp.default_strict_mode
2755 Disable lacp strict compliance on the interface.
2756 .It Cm rr_limit Ar number
2757 Configure a stride for an interface in round-robin mode.
2758 The default stride is 1.
2760 .Ss Generic IP Tunnel Parameters
2761 The following parameters apply to IP tunnel interfaces,
2763 .Bl -tag -width indent
2764 .It Cm tunnel Ar src_addr dest_addr
2765 Configure the physical source and destination address for IP tunnel
2771 are interpreted as the outer source/destination for the encapsulating
2774 Unconfigure the physical source and destination address for IP tunnel
2775 interfaces previously configured with
2778 Another name for the
2781 .It Cm accept_rev_ethip_ver
2782 Set a flag to accept both correct EtherIP packets and ones
2783 with reversed version field.
2785 This is for backward compatibility with
2787 6.2, 6.3, 7.0, and 7.1.
2788 .It Cm -accept_rev_ethip_ver
2790 .Cm accept_rev_ethip_ver .
2791 .It Cm ignore_source
2792 Set a flag to accept encapsulated packets destined to this host
2793 independently from source address.
2794 This may be useful for hosts, that receive encapsulated packets
2795 from the load balancers.
2796 .It Cm -ignore_source
2799 .It Cm send_rev_ethip_ver
2800 Set a flag to send EtherIP packets with reversed version
2801 field intentionally.
2802 Disabled by default.
2803 This is for backward compatibility with
2805 6.2, 6.3, 7.0, and 7.1.
2806 .It Cm -send_rev_ethip_ver
2808 .Cm send_rev_ethip_ver .
2810 .Ss GRE Tunnel Parameters
2811 The following parameters apply to GRE tunnel interfaces,
2813 .Bl -tag -width indent
2814 .It Cm tunnel Ar src_addr dest_addr
2815 Configure the physical source and destination address for GRE tunnel
2821 are interpreted as the outer source/destination for the encapsulating
2824 Unconfigure the physical source and destination address for GRE tunnel
2825 interfaces previously configured with
2828 Another name for the
2831 .It Cm grekey Ar key
2832 Configure the GRE key to be used for outgoing packets.
2834 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2835 This command will result in a four byte MTU reduction on the interface.
2837 .Ss Packet Filter State Table Sychronisation Parameters
2838 The following parameters are specific to
2841 .Bl -tag -width indent
2842 .It Cm syncdev Ar iface
2843 Use the specified interface
2844 to send and receive pfsync state synchronisation messages.
2846 Stop sending pfsync state synchronisation messages over the network.
2847 .It Cm syncpeer Ar peer_address
2848 Make the pfsync link point-to-point rather than using
2849 multicast to broadcast the state synchronisation messages.
2850 The peer_address is the IP address of the other host taking part in
2853 Broadcast the packets using multicast.
2855 Set the maximum number of updates for a single state which
2856 can be collapsed into one.
2857 This is an 8-bit number; the default value is 128.
2859 Defer transmission of the first packet in a state until a peer has
2860 acknowledged that the associated state has been inserted.
2862 Do not defer the first packet in a state.
2863 This is the default.
2866 The following parameters are specific to
2869 .Bl -tag -width indent
2870 .It Cm vlan Ar vlan_tag
2871 Set the VLAN tag value to
2873 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2874 or 802.1ad VLAN header for packets sent from the
2881 must both be set at the same time.
2882 .It Cm vlanproto Ar vlan_proto
2883 Set the VLAN encapsulation protocol to
2885 Supported encapsulation protocols are currently
2889 The default encapsulation protocol is
2893 protocol is also commonly known as
2895 either name can be used.
2896 .It Cm vlanpcp Ar priority_code_point
2899 is an 3-bit field which refers to the IEEE 802.1p
2900 class of service and maps to the frame priority level.
2902 Values in order of priority are:
2904 .Pq Dv Background (lowest) ,
2906 .Pq Dv Best effort (default) ,
2908 .Pq Dv Excellent effort ,
2910 .Pq Dv Critical applications ,
2912 .Pq Dv Video, < 100ms latency and jitter ,
2914 .Pq Dv Voice, < 10ms latency and jitter ,
2916 .Pq Dv Internetwork control ,
2918 .Pq Dv Network control (highest) .
2919 .It Cm vlandev Ar iface
2920 Associate the physical interface
2925 Packets transmitted through the
2928 diverted to the specified physical interface
2930 with 802.1Q VLAN encapsulation.
2931 Packets with 802.1Q encapsulation received
2932 by the parent interface with the correct VLAN Identifier will be diverted to
2938 interface is assigned a
2939 copy of the parent interface's flags and the parent's Ethernet address.
2944 must both be set at the same time.
2947 interface already has
2948 a physical interface associated with it, this command will fail.
2950 change the association to another physical interface, the existing
2951 association must be cleared first.
2953 Note: if the hardware tagging capability
2954 is set on the parent interface, the
2957 interface's behavior changes:
2960 interface recognizes that the
2961 parent interface supports insertion and extraction of VLAN tags on its
2962 own (usually in firmware) and that it should pass packets to and from
2963 the parent unaltered.
2964 .It Fl vlandev Op Ar iface
2967 pseudo device, disassociate the parent interface from it.
2968 This breaks the link between the
2970 interface and its parent,
2971 clears its VLAN Identifier, flags and its link address and shuts the interface
2975 argument is useless and hence deprecated.
2977 .Ss Virtual eXtensible LAN Parameters
2978 The following parameters are used to configure
2981 .Bl -tag -width indent
2982 .It Cm vxlanid Ar identifier
2983 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2984 virtual network segment membership of the interface.
2985 .It Cm vxlanlocal Ar address
2986 The source address used in the encapsulating IPv4/IPv6 header.
2987 The address should already be assigned to an existing interface.
2988 When the interface is configured in unicast mode, the listening socket
2989 is bound to this address.
2990 .It Cm vxlanremote Ar address
2991 The interface can be configured in a unicast, or point-to-point, mode
2992 to create a tunnel between two hosts.
2993 This is the IP address of the remote end of the tunnel.
2994 .It Cm vxlangroup Ar address
2995 The interface can be configured in a multicast mode
2996 to create a virtual network of hosts.
2997 This is the IP multicast group address the interface will join.
2998 .It Cm vxlanlocalport Ar port
2999 The port number the interface will listen on.
3000 The default port number is 4789.
3001 .It Cm vxlanremoteport Ar port
3002 The destination port number used in the encapsulating IPv4/IPv6 header.
3003 The remote host should be listening on this port.
3004 The default port number is 4789.
3005 Note some other implementations, such as Linux,
3006 do not default to the IANA assigned port,
3007 but instead listen on port 8472.
3008 .It Cm vxlanportrange Ar low high
3009 The range of source ports used in the encapsulating IPv4/IPv6 header.
3010 The port selected within the range is based on a hash of the inner frame.
3011 A range is useful to provide entropy within the outer IP header
3012 for more effective load balancing.
3013 The default range is between the
3016 .Va net.inet.ip.portrange.first
3018 .Va net.inet.ip.portrange.last
3019 .It Cm vxlantimeout Ar timeout
3020 The maximum time, in seconds, before an entry in the forwarding table
3022 The default is 1200 seconds (20 minutes).
3023 .It Cm vxlanmaxaddr Ar max
3024 The maximum number of entries in the forwarding table.
3025 The default is 2000.
3026 .It Cm vxlandev Ar dev
3027 When the interface is configured in multicast mode, the
3029 interface is used to transmit IP multicast packets.
3030 .It Cm vxlanttl Ar ttl
3031 The TTL used in the encapsulating IPv4/IPv6 header.
3034 The source IP address and inner source Ethernet MAC address of
3035 received packets are used to dynamically populate the forwarding table.
3036 When in multicast mode, an entry in the forwarding table allows the
3037 interface to send the frame directly to the remote host instead of
3038 broadcasting the frame to the multicast group.
3039 This is the default.
3041 The forwarding table is not populated by received packets.
3043 Delete all dynamically-learned addresses from the forwarding table.
3044 .It Cm vxlanflushall
3045 Delete all addresses, including static addresses, from the forwarding table.
3048 The following parameters are used to configure
3050 protocol on an interface:
3051 .Bl -tag -width indent
3053 Set the virtual host ID.
3054 This is a required setting to initiate
3056 If the virtual host ID does not exist yet, it is created and attached to the
3057 interface, otherwise configuration of an existing vhid is adjusted.
3060 keyword is supplied along with an
3064 address, then this address is configured to be run under control of the
3066 Whenever a last address that refers to a particular vhid is removed from an
3067 interface, the vhid is automatically removed from interface and destroyed.
3068 Any other configuration parameters for the
3070 protocol should be supplied along with the
3073 Acceptable values for vhid are 1 to 255.
3074 .It Cm advbase Ar seconds
3075 Specifies the base of the advertisement interval in seconds.
3076 The acceptable values are 1 to 255.
3077 The default value is 1.
3078 .It Cm advskew Ar interval
3079 Specifies the skew to add to the base advertisement interval to
3080 make one host advertise slower than another host.
3081 It is specified in 1/256 of seconds.
3082 The acceptable values are 1 to 254.
3083 The default value is 0.
3084 .It Cm pass Ar phrase
3085 Set the authentication key to
3087 .It Cm state Ar state
3088 Forcibly change state of a given vhid.
3089 The following states are recognized:
3095 The following environment variables affect the execution of
3097 .Bl -tag -width IFCONFIG_FORMAT
3098 .It Ev IFCONFIG_FORMAT
3099 This variable can contain a specification of the output format.
3100 See the description of the
3102 flag for more details.
3105 Assign the IPv4 address
3107 with a network mask of
3111 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3113 Add the IPv4 address
3115 with the CIDR network prefix
3119 .Dl # ifconfig em0 inet 192.0.2.45/28 alias
3121 Remove the IPv4 address
3125 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3127 Enable IPv6 functionality of the interface:
3128 .Dl # ifconfig em0 inet6 -ifdisabled
3130 Add the IPv6 address
3131 .Li 2001:DB8:DBDB::123/48
3134 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3135 Note that lower case hexadecimal IPv6 addresses are acceptable.
3137 Remove the IPv6 address added in the above example,
3140 character as shorthand for the network prefix:
3141 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 -alias
3143 Configure a single CARP redundant address on igb0, and then switch it
3145 .Bd -literal -offset indent -compact
3146 # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3147 # ifconfig igb0 vhid 1 state master
3150 Configure the interface
3152 to use 100baseTX, full duplex Ethernet media options:
3153 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3155 Label the em0 interface as an uplink:
3156 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3158 Create the software network interface
3160 .Dl # ifconfig gif1 create
3162 Destroy the software network interface
3164 .Dl # ifconfig gif1 destroy
3166 Display available wireless networks using
3168 .Dl # ifconfig wlan0 list scan
3170 Display inet and inet6 address subnet masks in CIDR notation
3171 .Dl # ifconfig -f inet:cidr,inet6:cidr
3173 Display interfaces that are up with the exception of loopback
3174 .Dl # ifconfig -a -u -G lo
3176 Display a list of interface names beloning to the wlan group:
3177 .Bd -literal -offset indent -compact
3183 Display details about the interfaces belonging to the wlan group:
3184 .Bd -literal -offset indent -compact
3185 # ifconfig -a -g wlan
3186 wlan0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3187 ether 75:4c:61:6b:7a:73
3188 inet6 fe80::4c75:636a:616e:ffd8%wlan0 prefixlen 64 scopeid 0x3
3189 inet6 2001:5761:6e64:6152:6f6d:616e:fea4:ffe2 prefixlen 64 autoconf
3190 inet 192.168.10.5 netmask 0xffffff00 broadcast 192.168.10.255
3192 ssid "Hotspot" channel 11 (2462 MHz 11g) bssid 12:34:ff:ff:43:21
3193 regdomain ETSI country DE authmode WPA2/802.11i privacy ON
3194 deftxkey UNDEF AES-CCM 2:128-bit AES-CCM 3:128-bit txpower 30 bmiss 10
3195 scanvalid 60 protmode CTS wme roaming MANUAL
3196 parent interface: iwm0
3197 media: IEEE 802.11 Wireless Ethernet DS/2Mbps mode 11g
3199 nd6 options=23<PERFORMNUD,ACCEPT_RTADV,AUTO_LINKLOCAL>
3200 wlan1: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3201 ether 00:50:69:6f:74:72
3203 ssid "" channel 2 (2417 MHz 11g)
3204 regdomain FCC country US authmode OPEN privacy OFF txpower 30 bmiss 7
3205 scanvalid 60 bgscan bgscanintvl 300 bgscanidle 250 roam:rssi 7
3206 roam:rate 5 protmode CTS wme bintval 0
3207 parent interface: rum0
3208 media: IEEE 802.11 Wireless Ethernet autoselect (autoselect)
3210 nd6 options=29<PERFORMNUD,IFDISABLED,AUTO_LINKLOCAL>
3213 Set a randomly-generated MAC address on tap0:
3214 .Dl # ifconfig tap0 ether random
3216 Messages indicating the specified interface does not exist, the
3217 requested address is unknown, or the user is not privileged and
3218 tried to alter an interface's configuration.
3240 Basic IPv6 node operation requires a link-local address on each
3241 interface configured for IPv6.
3242 Normally, such an address is automatically configured by the
3243 kernel on each interface added to the system or enabled; this behavior may
3244 be disabled by setting per-interface flag
3245 .Cm -auto_linklocal .
3246 The default value of this flag is 1 and can be disabled by using the sysctl
3248 .Va net.inet6.ip6.auto_linklocal .
3250 Do not configure IPv6 addresses with no link-local address by using
3252 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob