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
55 .Op Fl f Ar type Ns Cm \&: Ns Ar format
69 .Op Fl f Ar type Ns Cm \&: Ns Ar format
73 utility is used to assign an address
74 to a network interface and/or configure
75 network interface parameters.
78 utility must be used at boot time to define the network address
79 of each interface present on a machine; it may also be used at
80 a later time to redefine an interface's address
81 or other operating parameters.
83 The following options are available:
84 .Bl -tag -width indent
86 Display information about all interfaces in the system.
90 flag may be used instead of the
94 List all the interface cloners available on the system,
95 with no additional information.
96 Use of this flag is mutually exclusive with all other flags and commands.
98 Display only the interfaces that are down.
100 .Ar type Ns Cm \&: Ns Ar format Ns
101 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
103 Control the output format of
105 The format is specified as a comma-separated list of
106 .Ar type Ns Cm \&: Ns Ar format
110 section for more information
113 The output format can also be specified via the
115 environment variable.
118 flag can be supplied multiple times.
126 .Bl -tag -width ether
128 Adjust the display of inet and inet6 addresses:
130 .Bl -tag -width default -compact
135 Fully qualified domain names
138 Unqualified hostnames
143 Adjust the display of link-level ethernet (MAC) addresses:
145 .Bl -tag -width default -compact
147 Separate address segments with a colon
149 Separate address segments with a dash
155 Adjust the display of inet address subnet masks:
157 .Bl -tag -width default -compact
159 CIDR notation, for example:
165 Dotted quad notation, for example:
168 Hexadecimal format, for example:
172 Adjust the display of inet6 address prefixes (subnet masks):
174 .Bl -tag -width default -compact
176 CIDR notation, for example:
184 Integer format, for example:
188 .It Fl G Ar groupname
189 Exclude members of the specified
196 should be specified as later override previous ones
198 may contain shell patterns in which case it should be quoted.
199 .It Fl g Ar groupname
200 Limit the output to the members of the specified
205 should be specified as later override previous ones
207 may contain shell patterns in which case it should be quoted.
209 Print keying information for the
213 For example, the values of 802.11 WEP keys and
215 passphrases will be printed, if accessible to the current user.
217 This information is not printed by default, as it may be considered
220 Display address lifetime for IPv6 addresses as time offset string.
222 List all available interfaces on the system,
223 with no other additional information.
227 is specified, only interfaces of that type will be listed.
235 will exclude loopback interfaces from the list of Ethernet interfaces.
236 This is a special case, because all the other synonyms of the
238 address family will include loopback interfaces in the list.
240 Use of this flag is mutually exclusive
241 with all other flags and commands, except for
246 Display the capability list and all
247 of the supported media for the specified interface.
249 Disable automatic loading of network interface drivers.
251 If the network interface driver is not present in the kernel then
253 will attempt to load it.
254 This flag disables this behavior.
256 Display only the interfaces that are up.
258 Get more verbose status for an interface.
260 For the DARPA-Internet family,
261 the address is either a host name present in the host name data
264 or a DARPA Internet address expressed in the Internet standard
267 It is also possible to use the CIDR notation (also known as the
268 slash notation) to include the netmask.
269 That is, one can specify an address like
274 family, it is also possible to specify the prefix length using the slash
279 parameter below for more information.
280 .\" For the Xerox Network Systems(tm) family,
282 .\" .Ar net:a.b.c.d.e.f ,
285 .\" is the assigned network number (in decimal),
286 .\" and each of the six bytes of the host number,
290 .\" are specified in hexadecimal.
291 .\" The host number may be omitted on IEEE 802 protocol
292 .\" (Ethernet, FDDI, and Token Ring) interfaces,
293 .\" which use the hardware physical address,
294 .\" and on interfaces other than the first.
295 .\" For the ISO family, addresses are specified as a long hexadecimal string,
296 .\" as in the Xerox family.
297 .\" However, two consecutive dots imply a zero
298 .\" byte, and the dots are optional, if the user wishes to (carefully)
299 .\" count out long strings of digits in network byte order.
304 is specified as a series of colon-separated hex digits.
305 This can be used to, for example,
306 set a new MAC address on an Ethernet interface, though the
307 mechanism used is not Ethernet specific.
310 keyword to set a randomly generated MAC address.
311 A randomly-generated MAC address might be the same as one already in use
313 Such duplications are extremely unlikely.
314 If the interface is already
315 up when this option is used, it will be briefly brought down and
316 then brought back up again in order to ensure that the receive
317 filter in the underlying Ethernet hardware is properly reprogrammed.
318 .It Ar address_family
321 which affects interpretation of the remaining parameters.
322 Since an interface can receive transmissions in differing protocols
323 with different naming schemes, specifying the address family is recommended.
324 The address or protocol families currently
330 .Po with some exceptions, see
334 Default, if available.
345 Specify the address of the correspondent on the other end
346 of a point to point link.
349 parameter is a string of the form
357 utility displays the current configuration for a network interface
358 when no optional parameters are supplied.
359 If a protocol family is specified,
361 will report only the details specific to that protocol family.
363 When no arguments are given,
367 Only the super-user may modify the configuration of a network interface.
373 .Bl -tag -width indent
378 Introduced for compatibility
382 Establish an additional network address for this interface.
383 This is sometimes useful when changing network numbers, and
384 one wishes to accept packets addressed to the old interface.
385 If the address is on the same subnet as the first network address
386 for this interface, a non-conflicting netmask must be given.
391 Remove the network address specified.
392 This would be used if you incorrectly specified an alias, or it
393 was no longer needed.
394 If you have incorrectly set an NS address having the side effect
395 of specifying the host portion, removing all NS addresses will
396 allow you to respecify the host portion.
399 Specify that the address configured is an anycast address.
400 Based on the current specification,
401 only routers may configure anycast addresses.
402 Anycast address will not be used as source address of any of outgoing
405 Enable the use of the Address Resolution Protocol
408 between network level addresses and link level addresses (default).
409 This is currently implemented for mapping between DARPA Internet addresses
410 and IEEE 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
412 Disable the use of the Address Resolution Protocol
415 If the Address Resolution Protocol is enabled,
416 the host will only reply to requests for its addresses,
417 and will never send any requests.
419 If the Address Resolution Protocol is enabled,
420 the host will perform normally,
421 sending out requests and listening for replies.
424 Specify the address to use to represent broadcasts to the
426 The default broadcast address is the address with a host part of all 1's.
428 Enable driver dependent debugging code; usually, this turns on
429 extra console error logging.
431 Disable driver dependent debugging code.
433 Put interface into permanently promiscuous mode.
435 Disable permanently promiscuous mode.
440 .It Cm description Ar value , Cm descr Ar value
441 Specify a description of the interface.
442 This can be used to label interfaces in situations where they may
443 otherwise be difficult to distinguish.
444 .It Cm -description , Cm -descr
445 Clear the interface description.
449 When an interface is marked
451 the system will not attempt to
452 transmit messages through that interface.
453 If possible, the interface will be reset to disable reception as well.
454 This action does not automatically disable routes using the interface.
455 .It Cm group Ar groupname
456 Assign the interface to a
458 Any interface can be in multiple groups.
460 Cloned interfaces are members of their interface family group by default.
461 For example, a PPP interface such as
463 is a member of the PPP interface family group,
465 .\" The interface(s) the default route(s) point to are members of the
468 .It Cm -group Ar groupname
469 Remove the interface from the given
474 (lowermost 64bit of an IPv6 address)
476 .It Cm fib Ar fib_number
477 Specify interface FIB.
480 is assigned to all frames or packets received on that interface.
481 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
482 the default FIB (0) irrespective of the parent interface's FIB.
483 The kernel needs to be tuned to support more than the default FIB
486 kernel configuration option, or the
489 .It Cm tunnelfib Ar fib_number
493 is assigned to all packets encapsulated by tunnel interface, e.g.,
497 .It Cm maclabel Ar label
498 If Mandatory Access Control support is enabled in the kernel,
502 .\" .Xr maclabel 7 ) .
504 If the driver supports the media selection system, set the media type
507 Some interfaces support the mutually exclusive use of one of several
508 different physical media connectors.
509 For example, a 10Mbit/s Ethernet
510 interface might support the use of either AUI
511 or twisted pair connectors.
512 Setting the media type to
514 would change the currently active connector to the AUI port.
517 would activate twisted pair.
518 Refer to the interfaces' driver
519 specific documentation or man page for a complete list of the
521 .It Cm mediaopt Ar opts
522 If the driver supports the media selection system, set the specified
523 media options on the interface.
527 is a comma delimited list of options to apply to the interface.
528 Refer to the interfaces' driver specific man page for a complete
529 list of available options.
530 .It Fl mediaopt Ar opts
531 If the driver supports the media selection system, disable the
532 specified media options on the interface.
534 If the driver supports the media selection system, set the specified
535 operating mode on the interface to
537 For IEEE 802.11 wireless interfaces that support multiple operating modes
538 this directive is used to select between 802.11a
546 Set if the driver supports TX rate limiting.
547 .It Cm inst Ar minst , Cm instance Ar minst
548 Set the media instance to
550 This is useful for devices which have multiple physical layer interfaces
553 Set the interface name to
555 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
556 If the driver supports user-configurable checksum offloading,
557 enable receive (or transmit) checksum offloading on the interface.
558 The feature can be turned on selectively per protocol family.
560 .Cm rxcsum6 , txcsum6
566 Some drivers may not be able to enable these flags independently
567 of each other, so setting one may also set the other.
568 The driver will offload as much checksum work as it can reliably
569 support, the exact level of offloading varies between drivers.
570 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
571 If the driver supports user-configurable checksum offloading,
572 disable receive (or transmit) checksum offloading on the interface.
573 The feature can be turned off selectively per protocol family.
575 .Fl rxcsum6 , txcsum6
581 These settings may not always be independent of each other.
583 If the driver supports
585 segmentation offloading, enable TSO on the interface.
586 Some drivers may not be able to support TSO for
590 packets, so they may enable only one of them.
592 If the driver supports
594 segmentation offloading, disable TSO on the interface.
595 It will always disable TSO for
600 If the driver supports
602 segmentation offloading for
606 use one of these to selectively enabled it only for one protocol family.
608 If the driver supports
610 segmentation offloading for
614 use one of these to selectively disable it only for one protocol family.
616 If the driver supports
618 large receive offloading, enable LRO on the interface.
620 If the driver supports
622 large receive offloading, disable LRO on the interface.
624 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
625 segments the encrypted record into one or more
631 If the driver supports transmit TLS offload,
632 enable transmit TLS offload on the interface.
633 Some drivers may not be able to support transmit TLS offload for
637 packets, so they may enable only one of them.
639 If the driver supports transmit TLS offload,
640 disable transmit TLS offload on the interface.
641 It will always disable TLS for
646 Enable use of rate limiting (packet pacing) for TLS offload.
648 Disable use of rate limiting for TLS offload.
650 If the driver supports extended multi-page
652 buffers, enable them on the interface.
654 If the driver supports extended multi-page
656 biffers, disable them on the interface.
657 .It Cm wol , wol_ucast , wol_mcast , wol_magic
658 Enable Wake On Lan (WOL) support, if available.
659 WOL is a facility whereby a machine in a low power state may be woken
660 in response to a received packet.
661 There are three types of packets that may wake a system:
662 ucast (directed solely to the machine's mac address),
663 mcast (directed to a broadcast or multicast address),
666 .Po unicast or multicast frames with a
669 Not all devices support WOL, those that do indicate the mechanisms
670 they support in their capabilities.
672 is a synonym for enabling all available WOL mechanisms.
675 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
676 If the driver offers user-configurable VLAN support, enable
677 reception of extended frames, tag processing in hardware,
678 frame filtering in hardware, checksum offloading, or TSO on VLAN,
680 Note that this must be configured on a physical interface associated with
685 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
686 If the driver offers user-configurable VLAN support, disable
687 reception of extended frames, tag processing in hardware,
688 frame filtering in hardware, checksum offloading, or TSO on VLAN,
690 .It Cm vxlanhwcsum , vxlanhwtso
691 If the driver offers user-configurable VXLAN support, enable inner checksum
692 offloading (receive and transmit) or TSO on VXLAN, respectively.
693 Note that this must be configured on a physical interface associated with
698 The physical interface is either the interface specified as the vxlandev
699 or the interface hosting the vxlanlocal address.
700 The driver will offload as much checksum work and TSO as it can reliably
701 support, the exact level of offloading may vary between drivers.
702 .It Fl vxlanhwcsum , vxlanhwtso
703 If the driver offers user-configurable VXLAN support, disable checksum
704 offloading (receive and transmit) or TSO on VXLAN, respectively.
706 Move the interface to the
708 specified by name or JID.
709 If the jail has a virtual network stack, the interface will disappear
710 from the current environment and become visible to the jail.
712 Reclaim the interface from the
714 specified by name or JID.
715 If the jail has a virtual network stack, the interface will disappear
716 from the jail, and become visible to the current network environment.
720 feature and disable interrupts on the interface, if driver supports
725 feature and enable interrupt mode on the interface.
727 Create the specified network pseudo-device.
728 If the interface is given without a unit number, try to create a new
729 device with an arbitrary unit number.
730 If creation of an arbitrary device is successful, the new device name is
731 printed to standard output unless the interface is renamed or destroyed
736 Destroy the specified network pseudo-device.
741 Included for Solaris compatibility.
746 Included for Solaris compatibility.
748 Set the routing metric of the interface to
751 The routing metric is used by the routing protocol
753 Higher metrics have the effect of making a route
754 less favorable; metrics are counted as additional hops
755 to the destination network or host.
757 Set the maximum transmission unit of the interface to
759 default is interface specific.
760 The MTU is used to limit the size of packets that are transmitted on an
762 Not all interfaces support setting the MTU, and some interfaces have
764 .It Cm netmask Ar mask
767 Specify how much of the address to reserve for subdividing
768 networks into sub-networks.
769 The mask includes the network part of the local address
770 and the subnet part, which is taken from the host field of the address.
771 The mask can be specified as a single hexadecimal number
774 with a dot-notation Internet address,
775 or with a pseudo-network name listed in the network table
777 The mask contains 1's for the bit positions in the 32-bit address
778 which are to be used for the network and subnet parts,
779 and 0's for the host part.
780 The mask should contain at least the standard network portion,
781 and the subnet field should be contiguous with the network
784 The netmask can also be specified in CIDR notation after the address.
787 option above for more information.
788 .It Cm prefixlen Ar len
792 bits are reserved for subdividing networks into sub-networks.
795 must be integer, and for syntactical reason it must be between 0 to 128.
796 It is almost always 64 under the current IPv6 assignment rule.
797 If the parameter is omitted, 64 is used.
799 The prefix can also be specified using the slash notation after the address.
802 option above for more information.
807 Introduced for compatibility
811 .It Cm link Op Cm 0 No - Cm 2
813 Enable special processing of the link level of the interface.
814 These three options are interface specific in actual effect, however,
815 they are in general used to select special modes of operation.
817 of this is to enable SLIP compression, or to select the connector type
818 for some Ethernet cards.
819 Refer to the man page for the specific driver
820 for more information.
822 .It Fl link Op Cm 0 No - Cm 2
824 Disable special processing at the link level with the specified interface.
826 Put the interface in monitor mode.
827 No packets are transmitted, and received packets are discarded after
831 Take the interface out of monitor mode.
832 .It Cm pcp Ar priority_code_point
835 is an 3-bit field which refers to the IEEE 802.1p
836 class of service and maps to the frame priority level.
838 Stop tagging packets on the interface w/ the priority code point.
842 This may be used to enable an interface after an
844 It happens automatically when setting the first address on an interface.
845 If the interface was reset when previously marked down,
846 the hardware will be re-initialized.
848 .Ss ICMPv6 Neighbor Discovery Protocol Parameters
849 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
850 Note that the address family keyword
853 .Bl -tag -width indent
855 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
859 .Va net.inet6.ip6.accept_rtadv
860 controls whether this flag is set by default or not.
865 Set a flag to control whether routers from which the system accepts
866 Router Advertisement messages will be added to the Default Router List
870 flag is disabled, this flag has no effect.
874 .Va net.inet6.ip6.no_radr
875 controls whether this flag is set by default or not.
879 .It Cm auto_linklocal
880 Set a flag to perform automatic link-local address configuration when
881 the interface becomes available.
885 .Va net.inet6.ip6.auto_linklocal
886 controls whether this flag is set by default or not.
887 .It Cm -auto_linklocal
891 Set the specified interface as the default route when there is no
897 Set a flag to disable all of IPv6 network communications on the
899 Note that if there are already configured IPv6
900 addresses on that interface, all of them are marked as
902 and DAD will be performed when this flag is cleared.
906 When this flag is cleared and
908 flag is enabled, automatic configuration of a link-local address is
911 Set a flag to enable Neighbor Unreachability Detection.
915 .It Cm no_prefer_iface
916 Set a flag to not honor rule 5 of source address selection in RFC 3484.
917 In practice this means the address on the outgoing interface will not be
918 preferred, effectively yielding the decision to the address selection
919 policy table, configurable with
921 .It Cm -no_prefer_iface
923 .Cm no_prefer_iface .
925 Set a flag to disable Duplicate Address Detection.
931 The following parameters are specific for IPv6 addresses.
932 Note that the address family keyword
935 .Bl -tag -width indent
937 Set the IPv6 autoconfigured address bit.
939 Clear the IPv6 autoconfigured address bit.
941 Set the IPv6 deprecated address bit.
943 Clear the IPv6 deprecated address bit.
945 Set preferred lifetime for the address.
947 Set a flag to prefer address as a candidate of the source address for
949 .It Cm -prefer_source
953 Set valid lifetime for the address.
955 .Ss IEEE 802.11 Wireless Interfaces Cloning Parameters
956 The following parameters are specific to cloning
957 IEEE 802.11 wireless interfaces with the
960 .Bl -tag -width indent
961 .It Cm wlandev Ar device
964 as the parent for the cloned device.
965 .It Cm wlanmode Ar mode
966 Specify the operating mode for this cloned device.
984 The operating mode of a cloned interface cannot be changed.
987 mode is actually implemented as an
989 interface with special properties.
990 .It Cm wlanbssid Ar bssid
991 The 802.11 mac address to use for the bssid.
992 This must be specified at create time for a legacy
995 .It Cm wlanaddr Ar address
996 The local mac address.
997 If this is not specified then a mac address will automatically be assigned
998 to the cloned device.
999 Typically this address is the same as the address of the parent device
1002 parameter is specified then the driver will craft a unique address for
1003 the device (if supported).
1007 device as operating in
1011 devices have a fixed peer relationship and do not, for example, roam
1012 if their peer stops communicating.
1013 For completeness a Dynamic WDS (DWDS) interface may marked as
1016 Request a unique local mac address for the cloned device.
1017 This is only possible if the device supports multiple mac addresses.
1018 To force use of the parent's mac address use
1021 Mark the cloned interface as depending on hardware support to
1022 track received beacons.
1023 To have beacons tracked in software use
1029 can also be used to indicate no beacons should
1030 be transmitted; this can be useful when creating a WDS configuration but
1032 interfaces can only be created as companions to an access point.
1034 .Ss Cloned IEEE 802.11 Wireless Interface Parameters
1035 The following parameters are specific to IEEE 802.11 wireless interfaces
1039 .Bl -tag -width indent
1041 Enable sending and receiving AMPDU frames when using 802.11n (default).
1042 The 802.11n specification states a compliant station must be capable
1043 of receiving AMPDU frames but transmission is optional.
1046 to disable all use of AMPDU with 802.11n.
1047 For testing and/or to work around interoperability problems one can use
1051 to control use of AMPDU in one direction.
1052 .It Cm ampdudensity Ar density
1053 Set the AMPDU density parameter used when operating with 802.11n.
1054 This parameter controls the inter-packet gap for AMPDU frames.
1055 The sending device normally controls this setting but a receiving station
1056 may request wider gaps.
1059 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
1062 is treated the same as 0.
1063 .It Cm ampdulimit Ar limit
1064 Set the limit on packet size for receiving AMPDU frames when operating
1068 are 8192, 16384, 32768, and 65536 but one can also specify
1069 just the unique prefix: 8, 16, 32, 64.
1070 Note the sender may limit the size of AMPDU frames to be less
1071 than the maximum specified by the receiving station.
1073 Enable sending and receiving AMSDU frames when using 802.11n.
1074 By default AMSDU is received but not transmitted.
1077 to disable all use of AMSDU with 802.11n.
1078 For testing and/or to work around interoperability problems one can use
1082 to control use of AMSDU in one direction.
1083 .It Cm amsdulimit Ar limit
1084 Set the limit on packet size for sending and receiving AMSDU frames
1085 when operating with 802.11n.
1088 are 7935 and 3839 (bytes).
1089 Note the sender may limit the size of AMSDU frames to be less
1090 than the maximum specified by the receiving station.
1091 Note also that devices are not required to support the 7935 limit,
1092 only 3839 is required by the specification and the larger value
1093 may require more memory to be dedicated to support functionality
1094 that is rarely used.
1096 When operating as an access point, pass packets between
1097 wireless clients directly (default).
1098 To instead let them pass up through the
1099 system and be forwarded using some other mechanism, use
1101 Disabling the internal bridging
1102 is useful when traffic is to be processed with
1104 .It Cm authmode Ar mode
1105 Set the desired authentication mode in infrastructure mode.
1106 Not all adapters support all modes.
1109 .Cm none , open , shared
1115 (IEEE WPA/WPA2/802.11i).
1120 modes are only useful when using an authentication service
1121 (a supplicant for client operation or an authenticator when
1122 operating as an access point).
1123 Modes are case insensitive.
1125 Enable background scanning when operating as a station.
1126 Background scanning is a technique whereby a station associated to
1127 an access point will temporarily leave the channel to scan for
1128 neighboring stations.
1129 This allows a station to maintain a cache of nearby access points
1130 so that roaming between access points can be done without
1131 a lengthy scan operation.
1132 Background scanning is done only when a station is not busy and
1133 any outbound traffic will cancel a scan operation.
1134 Background scanning should never cause packets to be lost though
1135 there may be some small latency if outbound traffic interrupts a
1137 By default background scanning is enabled if the device is capable.
1138 To disable background scanning, use
1140 Background scanning is controlled by the
1145 Background scanning must be enabled for roaming; this is an artifact
1146 of the current implementation and may not be required in the future.
1147 .It Cm bgscanidle Ar idletime
1148 Set the minimum time a station must be idle (not transmitting or
1149 receiving frames) before a background scan is initiated.
1152 parameter is specified in milliseconds.
1153 By default a station must be idle at least 250 milliseconds before
1154 a background scan is initiated.
1155 The idle time may not be set to less than 100 milliseconds.
1156 .It Cm bgscanintvl Ar interval
1157 Set the interval at which background scanning is attempted.
1160 parameter is specified in seconds.
1161 By default a background scan is considered every 300 seconds (5 minutes).
1164 may not be set to less than 15 seconds.
1165 .It Cm bintval Ar interval
1166 Set the interval at which beacon frames are sent when operating in
1170 parameter is specified in TU's (1024 usecs).
1171 By default beacon frames are transmitted every 100 TU's.
1172 .It Cm bmissthreshold Ar count
1173 Set the number of consecutive missed beacons at which the station
1174 will attempt to roam (i.e., search for a new access point).
1177 parameter must be in the range 1 to 255; though the
1178 upper bound may be reduced according to device capabilities.
1179 The default threshold is 7 consecutive missed beacons; but
1180 this may be overridden by the device driver.
1181 Another name for the
1185 .It Cm bssid Ar address
1186 Specify the MAC address of the access point to use when operating
1187 as a station in a BSS network.
1188 This overrides any automatic selection done by the system.
1189 To disable a previously selected access point, supply
1194 This option is useful when more than one access point uses the same SSID.
1195 Another name for the
1200 Enable packet bursting.
1201 Packet bursting is a transmission technique whereby the wireless
1202 medium is acquired once to send multiple frames and the interframe
1204 This technique can significantly increase throughput by reducing
1205 transmission overhead.
1206 Packet bursting is supported by the 802.11e QoS specification
1207 and some devices that do not support QoS may still be capable.
1208 By default packet bursting is enabled if a device is capable
1210 To disable packet bursting, use
1212 .It Cm chanlist Ar channels
1213 Set the desired channels to use when scanning for access
1214 points, neighbors in an IBSS network, or looking for unoccupied
1215 channels when operating as an access point.
1216 The set of channels is specified as a comma-separated list with
1217 each element in the list representing either a single channel number or a range
1220 Channel numbers must be in the range 1 to 255 and be permissible
1221 according to the operating characteristics of the device.
1222 .It Cm channel Ar number
1223 Set a single desired channel.
1224 Channels range from 1 to 255, but the exact selection available
1225 depends on the region your adaptor was manufactured for.
1231 will clear any desired channel and, if the device is marked up,
1232 force a scan for a channel to operate on.
1233 Alternatively the frequency, in megahertz, may be specified
1234 instead of the channel number.
1236 When there are several ways to use a channel the channel
1237 number/frequency may be appended with attributes to clarify.
1238 For example, if a device is capable of operating on channel 6
1239 with 802.11n and 802.11g then one can specify that g-only use
1240 should be used by specifying
1242 Similarly the channel width can be specified by appending it
1247 specifies a 40MHz wide channel.
1248 These attributes can be combined as in:
1251 The full set of flags specified following a
1261 Atheros Dynamic Turbo mode
1270 Atheros Static Turbo mode
1272 Atheros Dynamic Turbo mode, or appended to
1278 The full set of channel widths following a
1284 5MHz aka quarter-rate channel
1286 10MHz aka half-rate channel
1288 20MHz mostly for use in specifying
1291 40MHz mostly for use in specifying
1296 a 40MHz HT channel specification may include the location
1297 of the extension channel by appending
1301 for above and below,
1304 specifies 40MHz wide HT operation
1305 with the center channel at frequency 2437 and the extension channel above.
1306 .It Cm country Ar name
1307 Set the country code to use in calculating the regulatory constraints
1309 In particular the set of available channels, how the wireless device
1310 will operation on the channels, and the maximum transmit power that
1311 can be used on a channel are defined by this setting.
1312 Country/Region codes are specified as a 2-character abbreviation
1313 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1314 e.g., "ES" and "Spain".
1315 The set of country codes are taken from
1316 .Pa /etc/regdomain.xml
1321 Note that not all devices support changing the country code from a default
1322 setting; typically stored in EEPROM.
1330 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1331 DFS embodies several facilities including detection of overlapping
1332 radar signals, dynamic transmit power control, and channel selection
1333 according to a least-congested criteria.
1334 DFS support is mandatory for some 5GHz frequencies in certain
1335 locales (e.g., ETSI).
1336 By default DFS is enabled according to the regulatory definitions
1338 .Pa /etc/regdomain.xml
1339 and the current country code, regdomain,
1341 Note the underlying device (and driver) must support radar detection
1342 for full DFS support to work.
1343 To be fully compliant with the local regulatory agency frequencies that
1344 require DFS should not be used unless it is fully supported.
1347 to disable this functionality for testing.
1349 Enable support for the 802.11d specification (default).
1350 When this support is enabled in station mode, beacon frames that advertise
1351 a country code different than the currently configured country code will
1352 cause an event to be dispatched to user applications.
1353 This event can be used by the station to adopt that country code and
1354 operate according to the associated regulatory constraints.
1355 When operating as an access point with 802.11d enabled the beacon and
1356 probe response frames transmitted will advertise the current regulatory
1358 To disable 802.11d use
1361 Enable 802.11h support including spectrum management.
1362 When 802.11h is enabled beacon and probe response frames will have
1363 the SpectrumMgt bit set in the capabilities field and
1364 country and power constraint information elements will be present.
1365 802.11h support also includes handling Channel Switch Announcements (CSA)
1366 which are a mechanism to coordinate channel changes by an access point.
1367 By default 802.11h is enabled if the device is capable.
1368 To disable 802.11h use
1370 .It Cm deftxkey Ar index
1371 Set the default key to use for transmission.
1372 Typically this is only set when using WEP encryption.
1373 Note that you must set a default transmit key
1374 for the system to know which key to use in encrypting outbound traffic.
1377 is an alias for this request; it is provided for backwards compatibility.
1378 .It Cm dtimperiod Ar period
1381 period for transmitting buffered multicast data frames when
1382 operating in ap mode.
1385 specifies the number of beacon intervals between DTIM
1386 and must be in the range 1 to 15.
1387 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1389 Enable the use of quiet IE.
1390 Hostap will use this to silence other
1391 stations to reduce interference for radar detection when
1392 operating on 5GHz frequency and doth support is enabled.
1395 to disable this functionality.
1396 .It Cm quiet_period Ar period
1399 to the number of beacon intervals between the start of regularly
1400 scheduled quiet intervals defined by Quiet element.
1401 .It Cm quiet_count Ar count
1404 to the number of TBTTs until the beacon interval during which the
1405 next quiet interval shall start.
1406 A value of 1 indicates the quiet
1407 interval will start during the beacon interval starting at the next
1409 A value 0 is reserved.
1410 .It Cm quiet_offset Ar offset
1413 to the offset of the start of the quiet interval from the TBTT
1414 specified by the Quiet count, expressed in TUs.
1417 shall be less than one beacon interval.
1418 .It Cm quiet_duration Ar dur
1421 to the duration of the Quiet interval, expressed in TUs.
1422 The value should be less than beacon interval.
1424 Enable the use of Atheros Dynamic Turbo mode when communicating with
1425 another Dynamic Turbo-capable station.
1426 Dynamic Turbo mode is an Atheros-specific mechanism by which
1427 stations switch between normal 802.11 operation and a
1429 mode in which a 40MHz wide channel is used for communication.
1430 Stations using Dynamic Turbo mode operate boosted only when the
1431 channel is free of non-dturbo stations; when a non-dturbo station
1432 is identified on the channel all stations will automatically drop
1433 back to normal operation.
1434 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1435 Note that turbo mode (dynamic or static) is only allowed on some
1436 channels depending on the regulatory constraints; use the
1438 command to identify the channels where turbo mode may be used.
1439 To disable Dynamic Turbo mode use
1442 Enable Dynamic WDS (DWDS) support.
1443 DWDS is a facility by which 4-address traffic can be carried between
1444 stations operating in infrastructure mode.
1445 A station first associates to an access point and authenticates using
1446 normal procedures (e.g., WPA).
1447 Then 4-address frames are passed to carry traffic for stations
1448 operating on either side of the wireless link.
1449 DWDS extends the normal WDS mechanism by leveraging existing security
1450 protocols and eliminating static binding.
1452 When DWDS is enabled on an access point 4-address frames received from
1453 an authorized station will generate a
1457 This event should be used to create a WDS interface that is bound
1458 to the remote station (and usually plumbed into a bridge).
1459 Once the WDS interface is up and running 4-address traffic then logically
1460 flows through that interface.
1462 When DWDS is enabled on a station, traffic with a destination address
1463 different from the peer station are encapsulated in a 4-address frame
1464 and transmitted to the peer.
1465 All 4-address traffic uses the security information of the stations
1466 (e.g., cryptographic keys).
1467 A station is associated using 802.11n facilities may transport
1468 4-address traffic using these same mechanisms; this depends on available
1469 resources and capabilities of the device.
1470 The DWDS implementation guards against layer 2 routing loops of
1473 Enable the use of Atheros Fast Frames when communicating with
1474 another Fast Frames-capable station.
1475 Fast Frames are an encapsulation technique by which two 802.3
1476 frames are transmitted in a single 802.11 frame.
1477 This can noticeably improve throughput but requires that the
1478 receiving station understand how to decapsulate the frame.
1479 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1480 protocol extension so enabling use is safe when communicating with
1481 non-Atheros devices.
1482 By default, use of fast frames is enabled if the device is capable.
1483 To explicitly disable fast frames, use
1485 .It Cm fragthreshold Ar length
1486 Set the threshold for which transmitted frames are broken into fragments.
1489 argument is the frame size in bytes and must be in the range 256 to 2346.
1497 disables transmit fragmentation.
1498 Not all adapters honor the fragmentation threshold.
1500 When operating as an access point, do not broadcast the SSID
1501 in beacon frames or respond to probe request frames unless
1502 they are directed to the ap (i.e., they include the ap's SSID).
1503 By default, the SSID is included in beacon frames and
1504 undirected probe request frames are answered.
1505 To re-enable the broadcast of the SSID etc., use
1508 Enable use of High Throughput (HT) when using 802.11n (default).
1509 The 802.11n specification includes mechanisms for operation
1510 on 20MHz and 40MHz wide channels using different signalling mechanisms
1511 than specified in 802.11b, 802.11g, and 802.11a.
1512 Stations negotiate use of these facilities, termed HT20 and HT40,
1513 when they associate.
1514 To disable all use of 802.11n use
1516 To disable use of HT20 (e.g., to force only HT40 use) use
1518 To disable use of HT40 use
1521 HT configuration is used to
1524 when several choices are available.
1525 For example, if a station associates to an 11n-capable access point
1526 it controls whether the station uses legacy operation, HT20, or HT40.
1527 When an 11n-capable device is setup as an access point and
1528 Auto Channel Selection is used to locate a channel to operate on,
1529 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1530 on the selected channel.
1531 If a fixed channel is specified for a station then HT configuration can
1532 be given as part of the channel specification; e.g., 6:ht/20 to setup
1533 HT20 operation on channel 6.
1535 Enable use of compatibility support for pre-802.11n devices (default).
1536 The 802.11n protocol specification went through several incompatible iterations.
1537 Some vendors implemented 11n support to older specifications that
1538 will not interoperate with a purely 11n-compliant station.
1539 In particular the information elements included in management frames
1540 for old devices are different.
1541 When compatibility support is enabled both standard and compatible data
1543 Stations that associate using the compatibility mechanisms are flagged
1546 To disable compatibility support use
1548 .It Cm htprotmode Ar technique
1549 For interfaces operating in 802.11n, use the specified
1551 for protecting HT frames in a mixed legacy/HT network.
1552 The set of valid techniques is
1557 Technique names are case insensitive.
1559 Enable inactivity processing for stations associated to an
1560 access point (default).
1561 When operating as an access point the 802.11 layer monitors
1562 the activity of each associated station.
1563 When a station is inactive for 5 minutes it will send several
1565 to see if the station is still present.
1566 If no response is received then the station is deauthenticated.
1567 Applications that prefer to handle this work can disable this
1571 Set the location to use in calculating regulatory constraints.
1572 The location is also advertised in beacon and probe response frames
1573 when 802.11d is enabled with
1582 Display the list of channels available for use taking into account
1583 any restrictions set with the
1586 See the description of
1588 for more information.
1590 Display the adaptor's capabilities, including the operating
1593 Display the list of channels available for use.
1594 Channels are shown with their IEEE channel number, equivalent
1595 frequency, and usage modes.
1596 Channels identified as
1601 Channels identified as
1603 may be used only for Atheros' Static Turbo mode
1605 . Cm mediaopt turbo ) .
1606 Channels marked with a
1608 have a regulatory constraint that they be passively scanned.
1609 This means a station is not permitted to transmit on the channel until
1610 it identifies the channel is being used for 802.11 communication;
1611 typically by hearing a beacon frame from an access point operating
1614 is another way of requesting this information.
1615 By default a compacted list of channels is displayed; if the
1617 option is specified then all channels are shown.
1618 .It Cm list countries
1619 Display the set of country codes and regulatory domains that can be
1620 used in regulatory configuration.
1622 Display the current MAC Access Control List state.
1623 Each address is prefixed with a character that indicates the
1624 current policy applied to it:
1626 indicates the address is allowed access,
1628 indicates the address is denied access,
1630 indicates the address is present but the current policy open
1631 (so the ACL is not consulted).
1633 Displays the mesh routing table, used for forwarding packets on a mesh
1635 .It Cm list regdomain
1636 Display the current regulatory settings including the available channels
1637 and transmit power caps.
1639 Display the parameters that govern roaming operation.
1641 Display the parameters that govern transmit operation.
1643 Display the transmit power caps for each channel.
1645 Display the access points and/or ad-hoc neighbors
1646 located in the vicinity.
1647 This information may be updated automatically by the adapter
1650 request or through background scanning.
1651 Depending on the capabilities of the stations the following
1652 flags (capability codes) can be included in the output:
1659 Poll request capability.
1661 DSSS/OFDM capability.
1663 Extended Service Set (ESS).
1664 Indicates that the station is part of an infrastructure network
1665 rather than an IBSS/ad-hoc network.
1667 Independent Basic Service Set (IBSS).
1668 Indicates that the station is part of an ad-hoc network
1669 rather than an ESS network.
1672 The station requires authentication and encryption
1673 for all data frames exchanged within the BSS using cryptographic means
1674 such as WEP, TKIP, or AES-CCMP.
1676 Robust Secure Network (RSN).
1679 Indicates that the network is using short preambles,
1680 defined in 802.11b High Rate/DSSS PHY,
1681 and utilizes a 56 bit sync field
1682 rather than the 128 bit field used in long preamble mode.
1683 Short preambles are used to optionally
1684 improve throughput performance with 802.11g and 802.11b.
1686 Pollable capability.
1688 Short slot time capability.
1689 Indicates that the 802.11g network is using a short slot time
1690 because there are no legacy (802.11b) stations present.
1693 By default interesting information elements captured from the neighboring
1694 stations are displayed at the end of each row.
1695 Possible elements include:
1697 (station supports WME),
1699 (station supports WPA),
1701 (station supports WPS),
1703 (station supports 802.11i/RSN),
1705 (station supports 802.11n/HT communication),
1707 (station supports Atheros protocol extensions),
1709 (station supports unknown vendor-specific extensions).
1712 flag is used all the information elements and their
1713 contents will be shown.
1716 flag also enables display of long SSIDs.
1719 command is another way of requesting this information.
1721 When operating as an access point display the stations that are
1722 currently associated.
1723 When operating in ad-hoc mode display stations identified as
1724 neighbors in the IBSS.
1725 When operating in mesh mode display stations identified as
1726 neighbors in the MBSS.
1727 When operating in station mode display the access point.
1728 Capabilities advertised by the stations are described under
1732 The following flags can be included in the output:
1736 Indicates that the station is permitted to send/receive data frames.
1738 Extended Rate Phy (ERP).
1739 Indicates that the station is operating in an 802.11g network
1740 using extended transmit rates.
1742 High Throughput (HT).
1743 Indicates that the station is using HT transmit rates.
1746 follows immediately after then the station associated
1747 using deprecated mechanisms supported only when
1752 Indicates that the station is operating in power save mode.
1754 Quality of Service (QoS).
1755 Indicates that the station is using QoS encapsulation for
1757 QoS encapsulation is enabled only when WME mode is enabled.
1759 Short GI in HT 40MHz mode enabled.
1762 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1764 Transitional Security Network (TSN).
1765 Indicates that the station associated using TSN; see also
1769 Wi-Fi Protected Setup (WPS).
1770 Indicates that the station associated using WPS.
1772 Short GI in HT 20MHz mode enabled.
1775 By default information elements received from associated stations
1776 are displayed in a short form; the
1778 flag causes this information to be displayed symbolically.
1780 Display the current channel parameters to use when operating in WME mode.
1783 option is specified then both channel and BSS parameters are displayed
1784 for each AC (first channel, then BSS).
1785 When WME mode is enabled for an adaptor this information will be
1786 displayed with the regular status; this command is mostly useful
1787 for examining parameters when WME mode is disabled.
1788 See the description of the
1790 directive for information on the various parameters.
1791 .It Cm maxretry Ar count
1792 Set the maximum number of tries to use in sending unicast frames.
1793 The default setting is 6 but drivers may override this with a value
1795 .It Cm mcastrate Ar rate
1796 Set the rate for transmitting multicast/broadcast frames.
1797 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1798 This rate should be valid for the current operating conditions;
1799 if an invalid rate is specified drivers are free to chose an
1801 .It Cm mgtrate Ar rate
1802 Set the rate for transmitting management and/or control frames.
1803 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1805 Set the location to use in calculating regulatory constraints.
1806 The location is also advertised in beacon and probe response frames
1807 when 802.11d is enabled with
1816 Enable powersave operation.
1817 When operating as a client, the station will conserve power by
1818 periodically turning off the radio and listening for
1819 messages from the access point telling it there are packets waiting.
1820 The station must then retrieve the packets.
1821 Not all devices support power save operation as a client.
1822 The 802.11 specification requires that all access points support
1823 power save but some drivers do not.
1826 to disable powersave operation when operating as a client.
1827 .It Cm powersavesleep Ar sleep
1828 Set the desired max powersave sleep time in TU's (1024 usecs).
1829 By default the max powersave sleep time is 100 TU's.
1830 .It Cm protmode Ar technique
1831 For interfaces operating in 802.11g, use the specified
1833 for protecting OFDM frames in a mixed 11b/11g network.
1834 The set of valid techniques is
1840 Technique names are case insensitive.
1841 Not all devices support
1843 as a protection technique.
1845 When operating as an access point in 802.11g mode allow only
1846 11g-capable stations to associate (11b-only stations are not
1847 permitted to associate).
1848 To allow both 11g and 11b-only stations to associate, use
1851 When operating as an access point in 802.11n mode allow only
1852 HT-capable stations to associate (legacy stations are not
1853 permitted to associate).
1854 To allow both HT and legacy stations to associate, use
1856 .It Cm regdomain Ar sku
1857 Set the regulatory domain to use in calculating the regulatory constraints
1859 In particular the set of available channels, how the wireless device
1860 will operation on the channels, and the maximum transmit power that
1861 can be used on a channel are defined by this setting.
1862 Regdomain codes (SKU's) are taken from
1863 .Pa /etc/regdomain.xml
1868 Note that not all devices support changing the regdomain from a default
1869 setting; typically stored in EEPROM.
1877 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1879 Note that RIFS must be supported by both the station and access point
1883 .It Cm roam:rate Ar rate
1884 Set the threshold for controlling roaming when operating in a BSS.
1887 parameter specifies the transmit rate in megabits
1888 at which roaming should be considered.
1889 If the current transmit rate drops below this setting and background scanning
1890 is enabled, then the system will check if a more desirable access point is
1891 available and switch over to it.
1892 The current scan cache contents are used if they are considered
1893 valid according to the
1895 parameter; otherwise a background scan operation is triggered before
1896 any selection occurs.
1897 Each channel type has a separate rate threshold; the default values are:
1898 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1899 .It Cm roam:rssi Ar rssi
1900 Set the threshold for controlling roaming when operating in a BSS.
1903 parameter specifies the receive signal strength in dBm units
1904 at which roaming should be considered.
1905 If the current rssi drops below this setting and background scanning
1906 is enabled, then the system will check if a more desirable access point is
1907 available and switch over to it.
1908 The current scan cache contents are used if they are considered
1909 valid according to the
1911 parameter; otherwise a background scan operation is triggered before
1912 any selection occurs.
1913 Each channel type has a separate rssi threshold; the default values are
1915 .It Cm roaming Ar mode
1916 When operating as a station, control how the system will
1917 behave when communication with the current access point
1921 argument may be one of
1923 (leave it to the hardware device to decide),
1925 (handle either in the device or the operating system\[em]as appropriate),
1927 (do nothing until explicitly instructed).
1928 By default, the device is left to handle this if it is
1929 capable; otherwise, the operating system will automatically
1930 attempt to reestablish communication.
1931 Manual mode is used by applications such as
1932 .Xr wpa_supplicant 8
1933 that want to control the selection of an access point.
1934 .It Cm rtsthreshold Ar length
1935 Set the threshold for which
1936 transmitted frames are preceded by transmission of an
1942 is the frame size in bytes and must be in the range 1 to 2346.
1950 disables transmission of RTS frames.
1951 Not all adapters support setting the RTS threshold.
1953 Initiate a scan of neighboring stations, wait for it to complete, and
1954 display all stations found.
1955 Only the super-user can initiate a scan.
1958 for information on the display.
1959 By default a background scan is done; otherwise a foreground
1960 scan is done and the station may roam to a different access point.
1963 request can be used to show recent scan results without
1964 initiating a new scan.
1965 .It Cm scanvalid Ar threshold
1966 Set the maximum time the scan cache contents are considered valid;
1967 i.e., will be used without first triggering a scan operation to
1971 parameter is specified in seconds and defaults to 60 seconds.
1972 The minimum setting for
1975 One should take care setting this threshold; if it is set too low
1976 then attempts to roam to another access point may trigger unnecessary
1977 background scan operations.
1979 Enable use of Short Guard Interval when operating in 802.11n
1981 NB: this currently enables Short GI on both HT40 and HT20 channels.
1982 To disable Short GI use
1985 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1986 when operating in 802.11n.
1987 A station operating with Static SMPS maintains only a single
1988 receive chain active (this can significantly reduce power consumption).
1992 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1993 when operating in 802.11n.
1994 A station operating with Dynamic SMPS maintains only a single
1995 receive chain active but switches to multiple receive chains when it
1996 receives an RTS frame (this can significantly reduce power consumption).
1997 Note that stations cannot distinguish between RTS/CTS intended to
1998 enable multiple receive chains and those used for other purposes.
2002 Set the desired Service Set Identifier (aka network name).
2003 The SSID is a string up to 32 characters
2004 in length and may be specified as either a normal string or in
2005 hexadecimal when preceded by
2007 Additionally, the SSID may be cleared by setting it to
2009 .It Cm tdmaslot Ar slot
2010 When operating with TDMA, use the specified
2015 is a number between 0 and the maximum number of slots in the BSS.
2016 Note that a station configured as slot 0 is a master and
2017 will broadcast beacon frames advertising the BSS;
2018 stations configured to use other slots will always
2019 scan to locate a master before they ever transmit.
2023 .It Cm tdmaslotcnt Ar cnt
2024 When operating with TDMA, setup a BSS with
2027 The slot count may be at most 8.
2028 The current implementation is only tested with two stations
2029 (i.e., point to point applications).
2030 This setting is only meaningful when a station is configured as slot 0;
2031 other stations adopt this setting from the BSS they join.
2035 .It Cm tdmaslotlen Ar len
2036 When operating with TDMA, setup a BSS such that each station has a slot
2039 The slot length must be at least 150 microseconds (1/8 TU)
2040 and no more than 65 milliseconds.
2041 Note that setting too small a slot length may result in poor channel
2042 bandwidth utilization due to factors such as timer granularity and
2044 This setting is only meaningful when a station is configured as slot 0;
2045 other stations adopt this setting from the BSS they join.
2048 is set to 10 milliseconds.
2049 .It Cm tdmabintval Ar intval
2050 When operating with TDMA, setup a BSS such that beacons are transmitted every
2052 superframes to synchronize the TDMA slot timing.
2053 A superframe is defined as the number of slots times the slot length; e.g.,
2054 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
2055 The beacon interval may not be zero.
2058 causes the timers to be resynchronized more often; this can be help if
2059 significant timer drift is observed.
2064 When operating as an access point with WPA/802.11i allow legacy
2065 stations to associate using static key WEP and open authentication.
2066 To disallow legacy station use of WEP, use
2068 .It Cm txpower Ar power
2069 Set the power used to transmit frames.
2072 argument is specified in .5 dBm units.
2073 Out of range values are truncated.
2074 Typically only a few discreet power settings are available and
2075 the driver will use the setting closest to the specified value.
2076 Not all adapters support changing the transmit power.
2077 .It Cm ucastrate Ar rate
2078 Set a fixed rate for transmitting unicast frames.
2079 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
2080 This rate should be valid for the current operating conditions;
2081 if an invalid rate is specified drivers are free to chose an
2083 .It Cm wepmode Ar mode
2084 Set the desired WEP mode.
2085 Not all adapters support all modes.
2086 The set of valid modes is
2092 mode explicitly tells the adaptor to allow association with access
2093 points which allow both encrypted and unencrypted traffic.
2096 means that the access point must only allow encrypted connections.
2099 is generally another name for
2101 Modes are case insensitive.
2102 .It Cm weptxkey Ar index
2103 Set the WEP key to be used for transmission.
2104 This is the same as setting the default transmission key with
2106 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
2107 Set the selected WEP key.
2110 is not given, key 1 is set.
2111 A WEP key will be either 5 or 13
2112 characters (40 or 104 bits) depending on the local network and the
2113 capabilities of the adaptor.
2114 It may be specified either as a plain
2115 string or as a string of hexadecimal digits preceded by
2117 For maximum portability, hex keys are recommended;
2118 the mapping of text keys to WEP encryption is usually driver-specific.
2119 In particular, the Windows drivers do this mapping differently to
2121 A key may be cleared by setting it to
2123 If WEP is supported then there are at least four keys.
2124 Some adapters support more than four keys.
2125 If that is the case, then the first four keys
2126 (1-4) will be the standard temporary keys and any others will be adaptor
2127 specific keys such as permanent keys stored in NVRAM.
2129 Note that you must set a default transmit key with
2131 for the system to know which key to use in encrypting outbound traffic.
2133 Enable Wireless Multimedia Extensions (WME) support, if available,
2134 for the specified interface.
2135 WME is a subset of the IEEE 802.11e standard to support the
2136 efficient communication of realtime and multimedia data.
2137 To disable WME support, use
2139 Another name for this parameter is
2142 The following parameters are meaningful only when WME support is in use.
2143 Parameters are specified per-AC (Access Category) and
2144 split into those that are used by a station when acting
2145 as an access point and those for client stations in the BSS.
2146 The latter are received from the access point and may not be changed
2148 The following Access Categories are recognized:
2150 .Bl -tag -width ".Cm AC_BK" -compact
2154 best effort delivery,
2169 AC parameters are case-insensitive.
2170 Traffic classification is done in the operating system using the
2171 vlan priority associated with data frames or the
2172 ToS (Type of Service) indication in IP-encapsulated frames.
2173 If neither information is present, traffic is assigned to the
2174 Best Effort (BE) category.
2175 .Bl -tag -width indent
2177 Set the ACK policy for QoS transmissions by the local station;
2178 this controls whether or not data frames transmitted by a station
2179 require an ACK response from the receiving station.
2180 To disable waiting for an ACK use
2182 This parameter is applied only to the local station.
2184 Enable the Admission Control Mandatory (ACM) mechanism
2185 for transmissions by the local station.
2186 To disable the ACM use
2188 On stations in a BSS this parameter is read-only and indicates
2189 the setting received from the access point.
2190 NB: ACM is not supported right now.
2191 .It Cm aifs Ar ac Ar count
2192 Set the Arbitration Inter Frame Spacing (AIFS)
2193 channel access parameter to use for transmissions
2194 by the local station.
2195 On stations in a BSS this parameter is read-only and indicates
2196 the setting received from the access point.
2197 .It Cm cwmin Ar ac Ar count
2198 Set the CWmin channel access parameter to use for transmissions
2199 by the local station.
2200 On stations in a BSS this parameter is read-only and indicates
2201 the setting received from the access point.
2202 .It Cm cwmax Ar ac Ar count
2203 Set the CWmax channel access parameter to use for transmissions
2204 by the local station.
2205 On stations in a BSS this parameter is read-only and indicates
2206 the setting received from the access point.
2207 .It Cm txoplimit Ar ac Ar limit
2208 Set the Transmission Opportunity Limit channel access parameter
2209 to use for transmissions by the local station.
2210 This parameter defines an interval of time when a WME station
2211 has the right to initiate transmissions onto the wireless medium.
2212 On stations in a BSS this parameter is read-only and indicates
2213 the setting received from the access point.
2214 .It Cm bss:aifs Ar ac Ar count
2215 Set the AIFS channel access parameter to send to stations in a BSS.
2216 This parameter is meaningful only when operating in ap mode.
2217 .It Cm bss:cwmin Ar ac Ar count
2218 Set the CWmin channel access parameter to send to stations in a BSS.
2219 This parameter is meaningful only when operating in ap mode.
2220 .It Cm bss:cwmax Ar ac Ar count
2221 Set the CWmax channel access parameter to send to stations in a BSS.
2222 This parameter is meaningful only when operating in ap mode.
2223 .It Cm bss:txoplimit Ar ac Ar limit
2224 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2225 This parameter is meaningful only when operating in ap mode.
2228 Enable Wireless Privacy Subscriber support.
2229 Note that WPS support requires a WPS-capable supplicant.
2230 To disable this function use
2233 .Ss MAC-Based Access Control List Parameters
2234 The following parameters support an optional access control list
2235 feature available with some adapters when operating in ap mode; see
2237 This facility allows an access point to accept/deny association
2238 requests based on the MAC address of the station.
2239 Note that this feature does not significantly enhance security
2240 as MAC address spoofing is easy to do.
2241 .Bl -tag -width indent
2242 .It Cm mac:add Ar address
2243 Add the specified MAC address to the database.
2244 Depending on the policy setting association requests from the
2245 specified station will be allowed or denied.
2247 Set the ACL policy to permit association only by
2248 stations registered in the database.
2249 .It Cm mac:del Ar address
2250 Delete the specified MAC address from the database.
2252 Set the ACL policy to deny association only by
2253 stations registered in the database.
2254 .It Cm mac:kick Ar address
2255 Force the specified station to be deauthenticated.
2256 This typically is done to block a station after updating the
2259 Set the ACL policy to allow all stations to associate.
2261 Delete all entries in the database.
2263 Set the ACL policy to permit association only by
2264 stations approved by a RADIUS server.
2265 Note that this feature requires the
2267 program be configured to do the right thing
2268 as it handles the RADIUS processing
2269 (and marks stations as authorized).
2271 .Ss Mesh Mode Wireless Interface Parameters
2272 The following parameters are related to a wireless interface operating in mesh
2274 .Bl -tag -width indent
2275 .It Cm meshid Ar meshid
2276 Set the desired Mesh Identifier.
2277 The Mesh ID is a string up to 32 characters in length.
2278 A mesh interface must have a Mesh Identifier specified
2279 to reach an operational state.
2280 .It Cm meshttl Ar ttl
2283 for mesh forwarded packets;
2284 this is the number of hops a packet may be forwarded before
2286 The default setting for
2290 Enable or disable peering with neighbor mesh stations.
2291 Stations must peer before any data packets can be exchanged.
2296 Enable or disable forwarding packets by a mesh interface.
2301 This attribute specifies whether or not the mesh STA activates mesh gate
2306 .It Cm meshmetric Ar protocol
2309 as the link metric protocol used on a mesh network.
2310 The default protocol is called
2312 The mesh interface will restart after changing this setting.
2313 .It Cm meshpath Ar protocol
2316 as the path selection protocol used on a mesh network.
2317 The only available protocol at the moment is called
2319 (Hybrid Wireless Mesh Protocol).
2320 The mesh interface will restart after changing this setting.
2321 .It Cm hwmprootmode Ar mode
2322 Stations on a mesh network can operate as
2324 Root nodes try to find paths to all mesh nodes and advertise themselves
2326 When there is a root mesh node on a network, other mesh nodes can setup
2327 paths between themselves faster because they can use the root node
2328 to find the destination.
2329 This path may not be the best, but on-demand
2330 routing will eventually find the best path.
2331 The following modes are recognized:
2333 .Bl -tag -width ".Cm PROACTIVE" -compact
2337 Send broadcast path requests every two seconds.
2338 Nodes on the mesh without a path to this root mesh station with try to
2339 discover a path to us.
2341 Send broadcast path requests every two seconds and every node must reply
2342 with a path reply even if it already has a path to this root mesh station.
2344 Send broadcast root announcement (RANN) frames.
2345 Nodes on the mesh without a path to this root mesh station with try to
2346 discover a path to us.
2352 .It Cm hwmpmaxhops Ar cnt
2353 Set the maximum number of hops allowed in an HMWP path to
2355 The default setting for
2359 .Ss Compatibility Parameters
2360 The following parameters are for compatibility with other systems:
2361 .Bl -tag -width indent
2363 Another name for the
2369 .It Cm stationname Ar name
2370 Set the name of this station.
2371 The station name is not part of the IEEE 802.11
2372 protocol though some interfaces support it.
2374 seems to be meaningful to identical or virtually identical equipment.
2375 Setting the station name is identical in syntax to setting the SSID.
2382 Another way of saying
2388 Another way of saying
2394 Another way of saying:
2395 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2401 .Ar n : k1 , k2 , k3 , k4
2404 Another way of saying
2405 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2410 Another way of saying
2416 .Ss Bridge Interface Parameters
2417 The following parameters are specific to bridge interfaces:
2418 .Bl -tag -width indent
2419 .It Cm addm Ar interface
2420 Add the interface named by
2422 as a member of the bridge.
2423 The interface is put into promiscuous mode
2424 so that it can receive every packet sent on the network.
2425 .It Cm deletem Ar interface
2426 Remove the interface named by
2429 Promiscuous mode is disabled on the interface when
2430 it is removed from the bridge.
2431 .It Cm maxaddr Ar size
2432 Set the size of the bridge address cache to
2434 The default is 2000 entries.
2435 .It Cm timeout Ar seconds
2436 Set the timeout of address cache entries to
2441 is zero, then address cache entries will not be expired.
2442 The default is 1200 seconds.
2444 Display the addresses that have been learned by the bridge.
2445 .It Cm static Ar interface-name Ar address
2446 Add a static entry into the address cache pointing to
2447 .Ar interface-name .
2448 Static entries are never aged out of the cache or re-placed, even if the
2449 address is seen on a different interface.
2450 .It Cm deladdr Ar address
2453 from the address cache.
2455 Delete all dynamically-learned addresses from the address cache.
2457 Delete all addresses, including static addresses, from the address cache.
2458 .It Cm discover Ar interface
2459 Mark an interface as a
2462 When the bridge has no address cache entry
2463 (either dynamic or static)
2464 for the destination address of a packet,
2465 the bridge will forward the packet to all
2466 member interfaces marked as
2468 This is the default for all interfaces added to a bridge.
2469 .It Cm -discover Ar interface
2472 attribute on a member interface.
2473 For packets without the
2475 attribute, the only packets forwarded on the interface are broadcast
2476 or multicast packets and packets for which the destination address
2477 is known to be on the interface's segment.
2478 .It Cm learn Ar interface
2479 Mark an interface as a
2482 When a packet arrives on such an interface, the source
2483 address of the packet is entered into the address cache as being a
2484 destination address on the interface's segment.
2485 This is the default for all interfaces added to a bridge.
2486 .It Cm -learn Ar interface
2489 attribute on a member interface.
2490 .It Cm sticky Ar interface
2491 Mark an interface as a
2494 Dynamically learned address entries are treated at static once entered into
2496 Sticky entries are never aged out of the cache or replaced, even if the
2497 address is seen on a different interface.
2498 .It Cm -sticky Ar interface
2501 attribute on a member interface.
2502 .It Cm private Ar interface
2503 Mark an interface as a
2506 A private interface does not forward any traffic to any other port that is also
2507 a private interface.
2508 .It Cm -private Ar interface
2511 attribute on a member interface.
2512 .It Cm span Ar interface
2513 Add the interface named by
2515 as a span port on the bridge.
2516 Span ports transmit a copy of every frame received by the bridge.
2517 This is most useful for snooping a bridged network passively on
2518 another host connected to one of the span ports of the bridge.
2519 .It Cm -span Ar interface
2520 Delete the interface named by
2522 from the list of span ports of the bridge.
2523 .It Cm stp Ar interface
2524 Enable Spanning Tree protocol on
2528 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2529 Spanning Tree is used to detect and remove loops in a network topology.
2530 .It Cm -stp Ar interface
2531 Disable Spanning Tree protocol on
2533 This is the default for all interfaces added to a bridge.
2534 .It Cm edge Ar interface
2538 An edge port connects directly to end stations cannot create bridging
2539 loops in the network, this allows it to transition straight to forwarding.
2540 .It Cm -edge Ar interface
2541 Disable edge status on
2543 .It Cm autoedge Ar interface
2546 to automatically detect edge status.
2547 This is the default for all interfaces added to a bridge.
2548 .It Cm -autoedge Ar interface
2549 Disable automatic edge status on
2551 .It Cm ptp Ar interface
2554 as a point to point link.
2555 This is required for straight transitions to forwarding and
2556 should be enabled on a direct link to another RSTP capable switch.
2557 .It Cm -ptp Ar interface
2558 Disable point to point link status on
2560 This should be disabled for a half duplex link and for an interface
2561 connected to a shared network segment,
2562 like a hub or a wireless network.
2563 .It Cm autoptp Ar interface
2564 Automatically detect the point to point status on
2566 by checking the full duplex link status.
2567 This is the default for interfaces added to the bridge.
2568 .It Cm -autoptp Ar interface
2569 Disable automatic point to point link detection on
2571 .It Cm maxage Ar seconds
2572 Set the time that a Spanning Tree protocol configuration is valid.
2573 The default is 20 seconds.
2574 The minimum is 6 seconds and the maximum is 40 seconds.
2575 .It Cm fwddelay Ar seconds
2576 Set the time that must pass before an interface begins forwarding
2577 packets when Spanning Tree is enabled.
2578 The default is 15 seconds.
2579 The minimum is 4 seconds and the maximum is 30 seconds.
2580 .It Cm hellotime Ar seconds
2581 Set the time between broadcasting of Spanning Tree protocol
2582 configuration messages.
2583 The hello time may only be changed when operating in legacy stp mode.
2584 The default is 2 seconds.
2585 The minimum is 1 second and the maximum is 2 seconds.
2586 .It Cm priority Ar value
2587 Set the bridge priority for Spanning Tree.
2588 The default is 32768.
2589 The minimum is 0 and the maximum is 61440.
2590 .It Cm proto Ar value
2591 Set the Spanning Tree protocol.
2592 The default is rstp.
2593 The available options are stp and rstp.
2594 .It Cm holdcnt Ar value
2595 Set the transmit hold count for Spanning Tree.
2596 This is the number of packets transmitted before being rate limited.
2598 The minimum is 1 and the maximum is 10.
2599 .It Cm ifpriority Ar interface Ar value
2600 Set the Spanning Tree priority of
2605 The minimum is 0 and the maximum is 240.
2606 .It Cm ifpathcost Ar interface Ar value
2607 Set the Spanning Tree path cost of
2611 The default is calculated from the link speed.
2612 To change a previously selected path cost back to automatic, set the
2614 The minimum is 1 and the maximum is 200000000.
2615 .It Cm ifmaxaddr Ar interface Ar size
2616 Set the maximum number of hosts allowed from an interface, packets with unknown
2617 source addresses are dropped until an existing host cache entry expires or is
2619 Set to 0 to disable.
2621 .Ss Link Aggregation and Link Failover Parameters
2622 The following parameters are specific to lagg interfaces:
2623 .Bl -tag -width indent
2624 .It Cm laggtype Ar type
2625 When creating a lagg interface the type can be specified as either
2629 If not specified ethernet is the default lagg type.
2630 .It Cm laggport Ar interface
2631 Add the interface named by
2633 as a port of the aggregation interface.
2634 .It Cm -laggport Ar interface
2635 Remove the interface named by
2637 from the aggregation interface.
2638 .It Cm laggproto Ar proto
2639 Set the aggregation protocol.
2642 The available options are
2650 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2651 Set the packet layers to hash for aggregation protocols which load balance.
2654 The options can be combined using commas.
2656 .Bl -tag -width ".Cm l2" -compact
2658 src/dst mac address and optional vlan number.
2660 src/dst address for IPv4 or IPv6.
2662 src/dst port for TCP/UDP/SCTP.
2665 Enable local hash computation for RSS hash on the interface.
2670 modes will use the RSS hash from the network card if available
2671 to avoid computing one, this may give poor traffic distribution
2672 if the hash is invalid or uses less of the protocol header information.
2674 disables use of RSS hash from the network card.
2675 The default value can be set via the
2676 .Va net.link.lagg.default_use_flowid
2687 Use the RSS hash from the network card if available.
2688 .It Cm flowid_shift Ar number
2689 Set a shift parameter for RSS local hash computation.
2690 Hash is calculated by using flowid bits in a packet header mbuf
2691 which are shifted by the number of this parameter.
2693 Enable selection of egress ports based on the native
2695 domain for the packets being transmitted.
2696 This is currently only implemented for lacp mode.
2699 hardware, running a kernel compiled with the
2701 option, and when interfaces from multiple
2703 domains are ports of the aggregation interface.
2705 Disable selection of egress ports based on the native
2707 domain for the packets being transmitted.
2708 .It Cm lacp_fast_timeout
2709 Enable lacp fast-timeout on the interface.
2710 .It Cm -lacp_fast_timeout
2711 Disable lacp fast-timeout on the interface.
2713 Enable lacp strict compliance on the interface.
2714 The default value can be set via the
2715 .Va net.link.lagg.lacp.default_strict_mode
2726 Disable lacp strict compliance on the interface.
2727 .It Cm rr_limit Ar number
2728 Configure a stride for an interface in round-robin mode.
2729 The default stride is 1.
2731 .Ss Generic IP Tunnel Parameters
2732 The following parameters apply to IP tunnel interfaces,
2734 .Bl -tag -width indent
2735 .It Cm tunnel Ar src_addr dest_addr
2736 Configure the physical source and destination address for IP tunnel
2742 are interpreted as the outer source/destination for the encapsulating
2745 Unconfigure the physical source and destination address for IP tunnel
2746 interfaces previously configured with
2749 Another name for the
2752 .It Cm accept_rev_ethip_ver
2753 Set a flag to accept both correct EtherIP packets and ones
2754 with reversed version field.
2756 This is for backward compatibility with
2758 6.2, 6.3, 7.0, and 7.1.
2759 .It Cm -accept_rev_ethip_ver
2761 .Cm accept_rev_ethip_ver .
2762 .It Cm ignore_source
2763 Set a flag to accept encapsulated packets destined to this host
2764 independently from source address.
2765 This may be useful for hosts, that receive encapsulated packets
2766 from the load balancers.
2767 .It Cm -ignore_source
2770 .It Cm send_rev_ethip_ver
2771 Set a flag to send EtherIP packets with reversed version
2772 field intentionally.
2773 Disabled by default.
2774 This is for backward compatibility with
2776 6.2, 6.3, 7.0, and 7.1.
2777 .It Cm -send_rev_ethip_ver
2779 .Cm send_rev_ethip_ver .
2781 .Ss GRE Tunnel Parameters
2782 The following parameters apply to GRE tunnel interfaces,
2784 .Bl -tag -width indent
2785 .It Cm tunnel Ar src_addr dest_addr
2786 Configure the physical source and destination address for GRE tunnel
2792 are interpreted as the outer source/destination for the encapsulating
2795 Unconfigure the physical source and destination address for GRE tunnel
2796 interfaces previously configured with
2799 Another name for the
2802 .It Cm grekey Ar key
2803 Configure the GRE key to be used for outgoing packets.
2805 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2806 This command will result in a four byte MTU reduction on the interface.
2808 .Ss Packet Filter State Table Sychronisation Parameters
2809 The following parameters are specific to
2812 .Bl -tag -width indent
2813 .It Cm syncdev Ar iface
2814 Use the specified interface
2815 to send and receive pfsync state synchronisation messages.
2817 Stop sending pfsync state synchronisation messages over the network.
2818 .It Cm syncpeer Ar peer_address
2819 Make the pfsync link point-to-point rather than using
2820 multicast to broadcast the state synchronisation messages.
2821 The peer_address is the IP address of the other host taking part in
2824 Broadcast the packets using multicast.
2826 Set the maximum number of updates for a single state which
2827 can be collapsed into one.
2828 This is an 8-bit number; the default value is 128.
2830 Defer transmission of the first packet in a state until a peer has
2831 acknowledged that the associated state has been inserted.
2833 Do not defer the first packet in a state.
2834 This is the default.
2837 The following parameters are specific to
2840 .Bl -tag -width indent
2841 .It Cm vlan Ar vlan_tag
2842 Set the VLAN tag value to
2844 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2845 or 802.1ad VLAN header for packets sent from the
2852 must both be set at the same time.
2853 .It Cm vlanproto Ar vlan_proto
2854 Set the VLAN encapsulation protocol to
2856 Supported encapsulation protocols are currently
2860 The default encapsulation protocol is
2864 protocol is also commonly known as
2866 either name can be used.
2867 .It Cm vlanpcp Ar priority_code_point
2870 is an 3-bit field which refers to the IEEE 802.1p
2871 class of service and maps to the frame priority level.
2873 Values in order of priority are:
2875 .Pq Dv Background (lowest) ,
2877 .Pq Dv Best effort (default) ,
2879 .Pq Dv Excellent effort ,
2881 .Pq Dv Critical applications ,
2883 .Pq Dv Video, < 100ms latency and jitter ,
2885 .Pq Dv Voice, < 10ms latency and jitter ,
2887 .Pq Dv Internetwork control ,
2889 .Pq Dv Network control (highest) .
2890 .It Cm vlandev Ar iface
2891 Associate the physical interface
2896 Packets transmitted through the
2899 diverted to the specified physical interface
2901 with 802.1Q VLAN encapsulation.
2902 Packets with 802.1Q encapsulation received
2903 by the parent interface with the correct VLAN Identifier will be diverted to
2909 interface is assigned a
2910 copy of the parent interface's flags and the parent's Ethernet address.
2915 must both be set at the same time.
2918 interface already has
2919 a physical interface associated with it, this command will fail.
2921 change the association to another physical interface, the existing
2922 association must be cleared first.
2924 Note: if the hardware tagging capability
2925 is set on the parent interface, the
2928 interface's behavior changes:
2931 interface recognizes that the
2932 parent interface supports insertion and extraction of VLAN tags on its
2933 own (usually in firmware) and that it should pass packets to and from
2934 the parent unaltered.
2935 .It Fl vlandev Op Ar iface
2938 pseudo device, disassociate the parent interface from it.
2939 This breaks the link between the
2941 interface and its parent,
2942 clears its VLAN Identifier, flags and its link address and shuts the interface
2946 argument is useless and hence deprecated.
2948 .Ss Virtual eXtensible LAN Parameters
2949 The following parameters are used to configure
2952 .Bl -tag -width indent
2953 .It Cm vxlanid Ar identifier
2954 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2955 virtual network segment membership of the interface.
2956 .It Cm vxlanlocal Ar address
2957 The source address used in the encapsulating IPv4/IPv6 header.
2958 The address should already be assigned to an existing interface.
2959 When the interface is configured in unicast mode, the listening socket
2960 is bound to this address.
2961 .It Cm vxlanremote Ar address
2962 The interface can be configured in a unicast, or point-to-point, mode
2963 to create a tunnel between two hosts.
2964 This is the IP address of the remote end of the tunnel.
2965 .It Cm vxlangroup Ar address
2966 The interface can be configured in a multicast mode
2967 to create a virtual network of hosts.
2968 This is the IP multicast group address the interface will join.
2969 .It Cm vxlanlocalport Ar port
2970 The port number the interface will listen on.
2971 The default port number is 4789.
2972 .It Cm vxlanremoteport Ar port
2973 The destination port number used in the encapsulating IPv4/IPv6 header.
2974 The remote host should be listening on this port.
2975 The default port number is 4789.
2976 Note some other implementations, such as Linux,
2977 do not default to the IANA assigned port,
2978 but instead listen on port 8472.
2979 .It Cm vxlanportrange Ar low high
2980 The range of source ports used in the encapsulating IPv4/IPv6 header.
2981 The port selected within the range is based on a hash of the inner frame.
2982 A range is useful to provide entropy within the outer IP header
2983 for more effective load balancing.
2984 The default range is between the
2987 .Va net.inet.ip.portrange.first
2989 .Va net.inet.ip.portrange.last
2990 .It Cm vxlantimeout Ar timeout
2991 The maximum time, in seconds, before an entry in the forwarding table
2993 The default is 1200 seconds (20 minutes).
2994 .It Cm vxlanmaxaddr Ar max
2995 The maximum number of entries in the forwarding table.
2996 The default is 2000.
2997 .It Cm vxlandev Ar dev
2998 When the interface is configured in multicast mode, the
3000 interface is used to transmit IP multicast packets.
3001 .It Cm vxlanttl Ar ttl
3002 The TTL used in the encapsulating IPv4/IPv6 header.
3005 The source IP address and inner source Ethernet MAC address of
3006 received packets are used to dynamically populate the forwarding table.
3007 When in multicast mode, an entry in the forwarding table allows the
3008 interface to send the frame directly to the remote host instead of
3009 broadcasting the frame to the multicast group.
3010 This is the default.
3012 The forwarding table is not populated by received packets.
3014 Delete all dynamically-learned addresses from the forwarding table.
3015 .It Cm vxlanflushall
3016 Delete all addresses, including static addresses, from the forwarding table.
3019 The following parameters are used to configure
3021 protocol on an interface:
3022 .Bl -tag -width indent
3024 Set the virtual host ID.
3025 This is a required setting to initiate
3027 If the virtual host ID does not exist yet, it is created and attached to the
3028 interface, otherwise configuration of an existing vhid is adjusted.
3031 keyword is supplied along with an
3035 address, then this address is configured to be run under control of the
3037 Whenever a last address that refers to a particular vhid is removed from an
3038 interface, the vhid is automatically removed from interface and destroyed.
3039 Any other configuration parameters for the
3041 protocol should be supplied along with the
3044 Acceptable values for vhid are 1 to 255.
3045 .It Cm advbase Ar seconds
3046 Specifies the base of the advertisement interval in seconds.
3047 The acceptable values are 1 to 255.
3048 The default value is 1.
3049 .It Cm advskew Ar interval
3050 Specifies the skew to add to the base advertisement interval to
3051 make one host advertise slower than another host.
3052 It is specified in 1/256 of seconds.
3053 The acceptable values are 1 to 254.
3054 The default value is 0.
3055 .It Cm pass Ar phrase
3056 Set the authentication key to
3058 .It Cm state Ar state
3059 Forcibly change state of a given vhid.
3060 The following states are recognized:
3066 The following environment variables affect the execution of
3068 .Bl -tag -width IFCONFIG_FORMAT
3069 .It Ev IFCONFIG_FORMAT
3070 This variable can contain a specification of the output format.
3071 See the description of the
3073 flag for more details.
3076 Assign the IPv4 address
3078 with a network mask of
3082 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3084 Add the IPv4 address
3086 with the CIDR network prefix
3092 as a synonym for the canonical form of the option
3094 .Dl # ifconfig em0 inet 192.0.2.45/28 add
3096 Remove the IPv4 address
3100 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3102 Enable IPv6 functionality of the interface:
3103 .Dl # ifconfig em0 inet6 -ifdisabled
3105 Add the IPv6 address
3106 .Li 2001:DB8:DBDB::123/48
3109 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3110 Note that lower case hexadecimal IPv6 addresses are acceptable.
3112 Remove the IPv6 address added in the above example,
3115 character as shorthand for the network prefix,
3118 as a synonym for the canonical form of the option
3120 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 delete
3122 Configure a single CARP redundant address on igb0, and then switch it
3124 .Dl # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3125 .Dl # ifconfig igb0 vhid 1 state master
3127 Configure the interface
3129 to use 100baseTX, full duplex Ethernet media options:
3130 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3132 Label the em0 interface as an uplink:
3133 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3135 Create the software network interface
3137 .Dl # ifconfig gif1 create
3139 Destroy the software network interface
3141 .Dl # ifconfig gif1 destroy
3143 Display available wireless networks using
3145 .Dl # ifconfig wlan0 list scan
3147 Display inet and inet6 address subnet masks in CIDR notation
3148 .Dl # ifconfig -f inet:cidr,inet6:cidr
3150 Display interfaces that are up with the exception of loopback
3151 .Dl # ifconfig -a -u -G lo
3153 Messages indicating the specified interface does not exist, the
3154 requested address is unknown, or the user is not privileged and
3155 tried to alter an interface's configuration.
3178 Basic IPv6 node operation requires a link-local address on each
3179 interface configured for IPv6.
3180 Normally, such an address is automatically configured by the
3181 kernel on each interface added to the system or enabled; this behavior may
3182 be disabled by setting per-interface flag
3183 .Cm -auto_linklocal .
3184 The default value of this flag is 1 and can be disabled by using the sysctl
3186 .Va net.inet6.ip6.auto_linklocal .
3188 Do not configure IPv6 addresses with no link-local address by using
3190 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob