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
71 .Op Fl f Ar type Ns Cm \&: Ns Ar format
75 utility is used to assign an address
76 to a network interface and/or configure
77 network interface parameters.
80 utility must be used at boot time to define the network address
81 of each interface present on a machine; it may also be used at
82 a later time to redefine an interface's address
83 or other operating parameters.
85 The following options are available:
86 .Bl -tag -width indent
88 Display information about all interfaces in the system.
92 flag may be used instead of the
96 List all the interface cloners available on the system,
97 with no additional information.
98 Use of this flag is mutually exclusive with all other flags and commands.
100 Display only the interfaces that are down.
102 .Ar type Ns Cm \&: Ns Ar format Ns
103 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
105 Control the output format of
107 The format is specified as a comma-separated list of
108 .Ar type Ns Cm \&: Ns Ar format
112 section for more information
115 The output format can also be specified via the
117 environment variable.
120 flag can be supplied multiple times.
128 .Bl -tag -width ether
130 Adjust the display of inet and inet6 addresses:
132 .Bl -tag -width default -compact
137 Fully qualified domain names
140 Unqualified hostnames
145 Adjust the display of link-level ethernet (MAC) addresses:
147 .Bl -tag -width default -compact
149 Separate address segments with a colon
151 Separate address segments with a dash
157 Adjust the display of inet address subnet masks:
159 .Bl -tag -width default -compact
161 CIDR notation, for example:
167 Dotted quad notation, for example:
170 Hexadecimal format, for example:
174 Adjust the display of inet6 address prefixes (subnet masks):
176 .Bl -tag -width default -compact
178 CIDR notation, for example:
186 Integer format, for example:
190 .It Fl G Ar groupname
191 Exclude members of the specified
198 should be specified as later override previous ones
200 may contain shell patterns in which case it should be quoted.
201 .It Fl g Ar groupname
202 Limit the output to the members of the specified
207 should be specified as later override previous ones
209 may contain shell patterns in which case it should be quoted.
211 Print keying information for the
215 For example, the values of 802.11 WEP keys and
217 passphrases will be printed, if accessible to the current user.
219 This information is not printed by default, as it may be considered
222 Display address lifetime for IPv6 addresses as time offset string.
224 List all available interfaces on the system,
225 with no other additional information.
229 is specified, only interfaces of that type will be listed.
237 will exclude loopback interfaces from the list of Ethernet interfaces.
238 This is a special case, because all the other synonyms of the
240 address family will include loopback interfaces in the list.
242 Use of this flag is mutually exclusive
243 with all other flags and commands, except for
248 Display the capability list and all
249 of the supported media for the specified interface.
251 Disable automatic loading of network interface drivers.
253 If the network interface driver is not present in the kernel then
255 will attempt to load it.
256 This flag disables this behavior.
258 Display only the interfaces that are up.
260 Get more verbose status for an interface.
262 For the DARPA-Internet family,
263 the address is either a host name present in the host name data
266 or a DARPA Internet address expressed in the Internet standard
269 It is also possible to use the CIDR notation (also known as the
270 slash notation) to include the netmask.
271 That is, one can specify an address like
276 family, it is also possible to specify the prefix length using the slash
281 parameter below for more information.
286 is specified as a series of colon-separated hex digits.
287 This can be used to, for example,
288 set a new MAC address on an Ethernet interface, though the
289 mechanism used is not Ethernet specific.
293 keyword to set a randomly generated MAC address.
294 A randomly-generated MAC address might be the same as one already in use
296 Such duplications are extremely unlikely.
298 If the interface is already
299 up when the link-level address is modified,
300 it will be briefly brought down and
301 then brought back up again in order to ensure that the receive
302 filter in the underlying Ethernet hardware is properly reprogrammed.
303 .It Ar address_family
306 which affects interpretation of the remaining parameters.
307 Since an interface can receive transmissions in differing protocols
308 with different naming schemes, specifying the address family is recommended.
309 The address or protocol families currently
315 .Po with some exceptions, see
319 Default, if available.
330 Specify the address of the correspondent on the other end
331 of a point to point link.
334 parameter is a string of the form
342 utility displays the current configuration for a network interface
343 when no optional parameters are supplied.
344 If a protocol family is specified,
346 will report only the details specific to that protocol family.
348 When no arguments are given,
352 Only the super-user may modify the configuration of a network interface.
358 .Bl -tag -width indent
363 Introduced for compatibility
367 Establish an additional network address for this interface.
368 This is sometimes useful when changing network numbers, and
369 one wishes to accept packets addressed to the old interface.
370 If the address is on the same subnet as the first network address
371 for this interface, a non-conflicting netmask must be given.
376 Remove the network address specified.
377 This would be used if you incorrectly specified an alias, or it
378 was no longer needed.
379 If you have incorrectly set an NS address having the side effect
380 of specifying the host portion, removing all NS addresses will
381 allow you to respecify the host portion.
384 Specify that the address configured is an anycast address.
385 Based on the current specification,
386 only routers may configure anycast addresses.
387 Anycast address will not be used as source address of any of outgoing
390 Enable the use of the Address Resolution Protocol
393 between network level addresses and link level addresses (default).
394 This is currently implemented for mapping between DARPA Internet addresses
395 and IEEE 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
397 Disable the use of the Address Resolution Protocol
400 If the Address Resolution Protocol is enabled,
401 the host will only reply to requests for its addresses,
402 and will never send any requests.
404 If the Address Resolution Protocol is enabled,
405 the host will perform normally,
406 sending out requests and listening for replies.
409 Specify the address to use to represent broadcasts to the
411 The default broadcast address is the address with a host part of all 1's.
413 Enable driver dependent debugging code; usually, this turns on
414 extra console error logging.
416 Disable driver dependent debugging code.
418 Put interface into permanently promiscuous mode.
420 Disable permanently promiscuous mode.
425 .It Cm description Ar value , Cm descr Ar value
426 Specify a description of the interface.
427 This can be used to label interfaces in situations where they may
428 otherwise be difficult to distinguish.
429 .It Cm -description , Cm -descr
430 Clear the interface description.
434 When an interface is marked
436 the system will not attempt to
437 transmit messages through that interface.
438 If possible, the interface will be reset to disable reception as well.
439 This action does not automatically disable routes using the interface.
440 .It Cm group Ar groupname
441 Assign the interface to a
443 Any interface can be in multiple groups.
445 Cloned interfaces are members of their interface family group by default.
446 For example, a PPP interface such as
448 is a member of the PPP interface family group,
450 .\" The interface(s) the default route(s) point to are members of the
453 .It Cm -group Ar groupname
454 Remove the interface from the given
459 (lowermost 64bit of an IPv6 address)
461 .It Cm fib Ar fib_number
462 Specify interface FIB.
465 is assigned to all frames or packets received on that interface.
466 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
467 the default FIB (0) irrespective of the parent interface's FIB.
468 The kernel needs to be tuned to support more than the default FIB
471 kernel configuration option, or the
474 .It Cm tunnelfib Ar fib_number
478 is assigned to all packets encapsulated by tunnel interface, e.g.,
482 .It Cm maclabel Ar label
483 If Mandatory Access Control support is enabled in the kernel,
487 .\" .Xr maclabel 7 ) .
489 If the driver supports the media selection system, set the media type
492 Some interfaces support the mutually exclusive use of one of several
493 different physical media connectors.
494 For example, a 10Mbit/s Ethernet
495 interface might support the use of either AUI
496 or twisted pair connectors.
497 Setting the media type to
499 would change the currently active connector to the AUI port.
502 would activate twisted pair.
503 Refer to the interfaces' driver
504 specific documentation or man page for a complete list of the
506 .It Cm mediaopt Ar opts
507 If the driver supports the media selection system, set the specified
508 media options on the interface.
512 is a comma delimited list of options to apply to the interface.
513 Refer to the interfaces' driver specific man page for a complete
514 list of available options.
515 .It Fl mediaopt Ar opts
516 If the driver supports the media selection system, disable the
517 specified media options on the interface.
519 If the driver supports the media selection system, set the specified
520 operating mode on the interface to
522 For IEEE 802.11 wireless interfaces that support multiple operating modes
523 this directive is used to select between 802.11a
531 Set if the driver supports TX rate limiting.
532 .It Cm inst Ar minst , Cm instance Ar minst
533 Set the media instance to
535 This is useful for devices which have multiple physical layer interfaces
538 Set the interface name to
540 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
541 If the driver supports user-configurable checksum offloading,
542 enable receive (or transmit) checksum offloading on the interface.
543 The feature can be turned on selectively per protocol family.
545 .Cm rxcsum6 , txcsum6
551 Some drivers may not be able to enable these flags independently
552 of each other, so setting one may also set the other.
553 The driver will offload as much checksum work as it can reliably
554 support, the exact level of offloading varies between drivers.
555 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
556 If the driver supports user-configurable checksum offloading,
557 disable receive (or transmit) checksum offloading on the interface.
558 The feature can be turned off selectively per protocol family.
560 .Fl rxcsum6 , txcsum6
566 These settings may not always be independent of each other.
568 If the driver supports
570 segmentation offloading, enable TSO on the interface.
571 Some drivers may not be able to support TSO for
575 packets, so they may enable only one of them.
577 If the driver supports
579 segmentation offloading, disable TSO on the interface.
580 It will always disable TSO for
585 If the driver supports
587 segmentation offloading for
591 use one of these to selectively enabled it only for one protocol family.
593 If the driver supports
595 segmentation offloading for
599 use one of these to selectively disable it only for one protocol family.
601 If the driver supports
603 large receive offloading, enable LRO on the interface.
605 If the driver supports
607 large receive offloading, disable LRO on the interface.
609 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
610 segments the encrypted record into one or more
616 If the driver supports transmit TLS offload,
617 enable transmit TLS offload on the interface.
618 Some drivers may not be able to support transmit TLS offload for
622 packets, so they may enable only one of them.
624 If the driver supports transmit TLS offload,
625 disable transmit TLS offload on the interface.
626 It will always disable TLS for
631 Enable use of rate limiting (packet pacing) for TLS offload.
633 Disable use of rate limiting for TLS offload.
635 If the driver supports extended multi-page
637 buffers, enable them on the interface.
639 If the driver supports extended multi-page
641 biffers, disable them on the interface.
642 .It Cm wol , wol_ucast , wol_mcast , wol_magic
643 Enable Wake On Lan (WOL) support, if available.
644 WOL is a facility whereby a machine in a low power state may be woken
645 in response to a received packet.
646 There are three types of packets that may wake a system:
647 ucast (directed solely to the machine's mac address),
648 mcast (directed to a broadcast or multicast address),
651 .Po unicast or multicast frames with a
654 Not all devices support WOL, those that do indicate the mechanisms
655 they support in their capabilities.
657 is a synonym for enabling all available WOL mechanisms.
660 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
661 If the driver offers user-configurable VLAN support, enable
662 reception of extended frames, tag processing in hardware,
663 frame filtering in hardware, checksum offloading, or TSO on VLAN,
665 Note that this must be configured on a physical interface associated with
670 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
671 If the driver offers user-configurable VLAN support, disable
672 reception of extended frames, tag processing in hardware,
673 frame filtering in hardware, checksum offloading, or TSO on VLAN,
675 .It Cm vxlanhwcsum , vxlanhwtso
676 If the driver offers user-configurable VXLAN support, enable inner checksum
677 offloading (receive and transmit) or TSO on VXLAN, respectively.
678 Note that this must be configured on a physical interface associated with
683 The physical interface is either the interface specified as the vxlandev
684 or the interface hosting the vxlanlocal address.
685 The driver will offload as much checksum work and TSO as it can reliably
686 support, the exact level of offloading may vary between drivers.
687 .It Fl vxlanhwcsum , vxlanhwtso
688 If the driver offers user-configurable VXLAN support, disable checksum
689 offloading (receive and transmit) or TSO on VXLAN, respectively.
691 Move the interface to the
693 specified by name or JID.
694 If the jail has a virtual network stack, the interface will disappear
695 from the current environment and become visible to the jail.
697 Reclaim the interface from the
699 specified by name or JID.
700 If the jail has a virtual network stack, the interface will disappear
701 from the jail, and become visible to the current network environment.
705 feature and disable interrupts on the interface, if driver supports
710 feature and enable interrupt mode on the interface.
712 Create the specified network pseudo-device.
713 If the interface is given without a unit number, try to create a new
714 device with an arbitrary unit number.
715 If creation of an arbitrary device is successful, the new device name is
716 printed to standard output unless the interface is renamed or destroyed
721 Destroy the specified network pseudo-device.
726 Included for Solaris compatibility.
731 Included for Solaris compatibility.
733 Set the routing metric of the interface to
736 The routing metric is used by the routing protocol
738 Higher metrics have the effect of making a route
739 less favorable; metrics are counted as additional hops
740 to the destination network or host.
742 Set the maximum transmission unit of the interface to
744 default is interface specific.
745 The MTU is used to limit the size of packets that are transmitted on an
747 Not all interfaces support setting the MTU, and some interfaces have
749 .It Cm netmask Ar mask
752 Specify how much of the address to reserve for subdividing
753 networks into sub-networks.
754 The mask includes the network part of the local address
755 and the subnet part, which is taken from the host field of the address.
756 The mask can be specified as a single hexadecimal number
759 with a dot-notation Internet address,
760 or with a pseudo-network name listed in the network table
762 The mask contains 1's for the bit positions in the 32-bit address
763 which are to be used for the network and subnet parts,
764 and 0's for the host part.
765 The mask should contain at least the standard network portion,
766 and the subnet field should be contiguous with the network
769 The netmask can also be specified in CIDR notation after the address.
772 option above for more information.
773 .It Cm prefixlen Ar len
777 bits are reserved for subdividing networks into sub-networks.
780 must be integer, and for syntactical reason it must be between 0 to 128.
781 It is almost always 64 under the current IPv6 assignment rule.
782 If the parameter is omitted, 64 is used.
784 The prefix can also be specified using the slash notation after the address.
787 option above for more information.
792 Introduced for compatibility
796 .It Cm link Op Cm 0 No - Cm 2
798 Enable special processing of the link level of the interface.
799 These three options are interface specific in actual effect, however,
800 they are in general used to select special modes of operation.
802 of this is to enable SLIP compression, or to select the connector type
803 for some Ethernet cards.
804 Refer to the man page for the specific driver
805 for more information.
807 .It Fl link Op Cm 0 No - Cm 2
809 Disable special processing at the link level with the specified interface.
811 Put the interface in monitor mode.
812 No packets are transmitted, and received packets are discarded after
816 Take the interface out of monitor mode.
817 .It Cm pcp Ar priority_code_point
820 is an 3-bit field which refers to the IEEE 802.1p
821 class of service and maps to the frame priority level.
823 Stop tagging packets on the interface w/ the priority code point.
827 This may be used to enable an interface after an
829 It happens automatically when setting the first address on an interface.
830 If the interface was reset when previously marked down,
831 the hardware will be re-initialized.
833 .Ss ICMPv6 Neighbor Discovery Protocol Parameters
834 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
835 Note that the address family keyword
838 .Bl -tag -width indent
840 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
844 .Va net.inet6.ip6.accept_rtadv
845 controls whether this flag is set by default or not.
850 Set a flag to control whether routers from which the system accepts
851 Router Advertisement messages will be added to the Default Router List
855 flag is disabled, this flag has no effect.
859 .Va net.inet6.ip6.no_radr
860 controls whether this flag is set by default or not.
864 .It Cm auto_linklocal
865 Set a flag to perform automatic link-local address configuration when
866 the interface becomes available.
870 .Va net.inet6.ip6.auto_linklocal
871 controls whether this flag is set by default or not.
872 .It Cm -auto_linklocal
876 Set the specified interface as the default route when there is no
882 Set a flag to disable all of IPv6 network communications on the
884 Note that if there are already configured IPv6
885 addresses on that interface, all of them are marked as
887 and DAD will be performed when this flag is cleared.
891 When this flag is cleared and
893 flag is enabled, automatic configuration of a link-local address is
896 Set a flag to enable Neighbor Unreachability Detection.
900 .It Cm no_prefer_iface
901 Set a flag to not honor rule 5 of source address selection in RFC 3484.
902 In practice this means the address on the outgoing interface will not be
903 preferred, effectively yielding the decision to the address selection
904 policy table, configurable with
906 .It Cm -no_prefer_iface
908 .Cm no_prefer_iface .
910 Set a flag to disable Duplicate Address Detection.
916 The following parameters are specific for IPv6 addresses.
917 Note that the address family keyword
920 .Bl -tag -width indent
922 Set the IPv6 autoconfigured address bit.
924 Clear the IPv6 autoconfigured address bit.
926 Set the IPv6 deprecated address bit.
928 Clear the IPv6 deprecated address bit.
930 Set preferred lifetime for the address.
932 Set a flag to prefer address as a candidate of the source address for
934 .It Cm -prefer_source
938 Set valid lifetime for the address.
940 .Ss IEEE 802.11 Wireless Interfaces Cloning Parameters
941 The following parameters are specific to cloning
942 IEEE 802.11 wireless interfaces with the
945 .Bl -tag -width indent
946 .It Cm wlandev Ar device
949 as the parent for the cloned device.
950 .It Cm wlanmode Ar mode
951 Specify the operating mode for this cloned device.
969 The operating mode of a cloned interface cannot be changed.
972 mode is actually implemented as an
974 interface with special properties.
975 .It Cm wlanbssid Ar bssid
976 The 802.11 mac address to use for the bssid.
977 This must be specified at create time for a legacy
980 .It Cm wlanaddr Ar address
981 The local mac address.
982 If this is not specified then a mac address will automatically be assigned
983 to the cloned device.
984 Typically this address is the same as the address of the parent device
987 parameter is specified then the driver will craft a unique address for
988 the device (if supported).
992 device as operating in
996 devices have a fixed peer relationship and do not, for example, roam
997 if their peer stops communicating.
998 For completeness a Dynamic WDS (DWDS) interface may marked as
1001 Request a unique local mac address for the cloned device.
1002 This is only possible if the device supports multiple mac addresses.
1003 To force use of the parent's mac address use
1006 Mark the cloned interface as depending on hardware support to
1007 track received beacons.
1008 To have beacons tracked in software use
1014 can also be used to indicate no beacons should
1015 be transmitted; this can be useful when creating a WDS configuration but
1017 interfaces can only be created as companions to an access point.
1019 .Ss Cloned IEEE 802.11 Wireless Interface Parameters
1020 The following parameters are specific to IEEE 802.11 wireless interfaces
1024 .Bl -tag -width indent
1026 Enable sending and receiving AMPDU frames when using 802.11n (default).
1027 The 802.11n specification states a compliant station must be capable
1028 of receiving AMPDU frames but transmission is optional.
1031 to disable all use of AMPDU with 802.11n.
1032 For testing and/or to work around interoperability problems one can use
1036 to control use of AMPDU in one direction.
1037 .It Cm ampdudensity Ar density
1038 Set the AMPDU density parameter used when operating with 802.11n.
1039 This parameter controls the inter-packet gap for AMPDU frames.
1040 The sending device normally controls this setting but a receiving station
1041 may request wider gaps.
1044 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
1047 is treated the same as 0.
1048 .It Cm ampdulimit Ar limit
1049 Set the limit on packet size for receiving AMPDU frames when operating
1053 are 8192, 16384, 32768, and 65536 but one can also specify
1054 just the unique prefix: 8, 16, 32, 64.
1055 Note the sender may limit the size of AMPDU frames to be less
1056 than the maximum specified by the receiving station.
1058 Enable sending and receiving AMSDU frames when using 802.11n.
1059 By default AMSDU is received but not transmitted.
1062 to disable all use of AMSDU with 802.11n.
1063 For testing and/or to work around interoperability problems one can use
1067 to control use of AMSDU in one direction.
1068 .It Cm amsdulimit Ar limit
1069 Set the limit on packet size for sending and receiving AMSDU frames
1070 when operating with 802.11n.
1073 are 7935 and 3839 (bytes).
1074 Note the sender may limit the size of AMSDU frames to be less
1075 than the maximum specified by the receiving station.
1076 Note also that devices are not required to support the 7935 limit,
1077 only 3839 is required by the specification and the larger value
1078 may require more memory to be dedicated to support functionality
1079 that is rarely used.
1081 When operating as an access point, pass packets between
1082 wireless clients directly (default).
1083 To instead let them pass up through the
1084 system and be forwarded using some other mechanism, use
1086 Disabling the internal bridging
1087 is useful when traffic is to be processed with
1089 .It Cm authmode Ar mode
1090 Set the desired authentication mode in infrastructure mode.
1091 Not all adapters support all modes.
1094 .Cm none , open , shared
1100 (IEEE WPA/WPA2/802.11i).
1105 modes are only useful when using an authentication service
1106 (a supplicant for client operation or an authenticator when
1107 operating as an access point).
1108 Modes are case insensitive.
1110 Enable background scanning when operating as a station.
1111 Background scanning is a technique whereby a station associated to
1112 an access point will temporarily leave the channel to scan for
1113 neighboring stations.
1114 This allows a station to maintain a cache of nearby access points
1115 so that roaming between access points can be done without
1116 a lengthy scan operation.
1117 Background scanning is done only when a station is not busy and
1118 any outbound traffic will cancel a scan operation.
1119 Background scanning should never cause packets to be lost though
1120 there may be some small latency if outbound traffic interrupts a
1122 By default background scanning is enabled if the device is capable.
1123 To disable background scanning, use
1125 Background scanning is controlled by the
1130 Background scanning must be enabled for roaming; this is an artifact
1131 of the current implementation and may not be required in the future.
1132 .It Cm bgscanidle Ar idletime
1133 Set the minimum time a station must be idle (not transmitting or
1134 receiving frames) before a background scan is initiated.
1137 parameter is specified in milliseconds.
1138 By default a station must be idle at least 250 milliseconds before
1139 a background scan is initiated.
1140 The idle time may not be set to less than 100 milliseconds.
1141 .It Cm bgscanintvl Ar interval
1142 Set the interval at which background scanning is attempted.
1145 parameter is specified in seconds.
1146 By default a background scan is considered every 300 seconds (5 minutes).
1149 may not be set to less than 15 seconds.
1150 .It Cm bintval Ar interval
1151 Set the interval at which beacon frames are sent when operating in
1155 parameter is specified in TU's (1024 usecs).
1156 By default beacon frames are transmitted every 100 TU's.
1157 .It Cm bmissthreshold Ar count
1158 Set the number of consecutive missed beacons at which the station
1159 will attempt to roam (i.e., search for a new access point).
1162 parameter must be in the range 1 to 255; though the
1163 upper bound may be reduced according to device capabilities.
1164 The default threshold is 7 consecutive missed beacons; but
1165 this may be overridden by the device driver.
1166 Another name for the
1170 .It Cm bssid Ar address
1171 Specify the MAC address of the access point to use when operating
1172 as a station in a BSS network.
1173 This overrides any automatic selection done by the system.
1174 To disable a previously selected access point, supply
1179 This option is useful when more than one access point uses the same SSID.
1180 Another name for the
1185 Enable packet bursting.
1186 Packet bursting is a transmission technique whereby the wireless
1187 medium is acquired once to send multiple frames and the interframe
1189 This technique can significantly increase throughput by reducing
1190 transmission overhead.
1191 Packet bursting is supported by the 802.11e QoS specification
1192 and some devices that do not support QoS may still be capable.
1193 By default packet bursting is enabled if a device is capable
1195 To disable packet bursting, use
1197 .It Cm chanlist Ar channels
1198 Set the desired channels to use when scanning for access
1199 points, neighbors in an IBSS network, or looking for unoccupied
1200 channels when operating as an access point.
1201 The set of channels is specified as a comma-separated list with
1202 each element in the list representing either a single channel number or a range
1205 Channel numbers must be in the range 1 to 255 and be permissible
1206 according to the operating characteristics of the device.
1207 .It Cm channel Ar number
1208 Set a single desired channel.
1209 Channels range from 1 to 255, but the exact selection available
1210 depends on the region your adaptor was manufactured for.
1216 will clear any desired channel and, if the device is marked up,
1217 force a scan for a channel to operate on.
1218 Alternatively the frequency, in megahertz, may be specified
1219 instead of the channel number.
1221 When there are several ways to use a channel the channel
1222 number/frequency may be appended with attributes to clarify.
1223 For example, if a device is capable of operating on channel 6
1224 with 802.11n and 802.11g then one can specify that g-only use
1225 should be used by specifying
1227 Similarly the channel width can be specified by appending it
1232 specifies a 40MHz wide channel.
1233 These attributes can be combined as in:
1236 The full set of flags specified following a
1246 Atheros Dynamic Turbo mode
1255 Atheros Static Turbo mode
1257 Atheros Dynamic Turbo mode, or appended to
1263 The full set of channel widths following a
1269 5MHz aka quarter-rate channel
1271 10MHz aka half-rate channel
1273 20MHz mostly for use in specifying
1276 40MHz mostly for use in specifying
1281 a 40MHz HT channel specification may include the location
1282 of the extension channel by appending
1286 for above and below,
1289 specifies 40MHz wide HT operation
1290 with the center channel at frequency 2437 and the extension channel above.
1291 .It Cm country Ar name
1292 Set the country code to use in calculating the regulatory constraints
1294 In particular the set of available channels, how the wireless device
1295 will operation on the channels, and the maximum transmit power that
1296 can be used on a channel are defined by this setting.
1297 Country/Region codes are specified as a 2-character abbreviation
1298 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1299 e.g., "ES" and "Spain".
1300 The set of country codes are taken from
1301 .Pa /etc/regdomain.xml
1306 Note that not all devices support changing the country code from a default
1307 setting; typically stored in EEPROM.
1315 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1316 DFS embodies several facilities including detection of overlapping
1317 radar signals, dynamic transmit power control, and channel selection
1318 according to a least-congested criteria.
1319 DFS support is mandatory for some 5GHz frequencies in certain
1320 locales (e.g., ETSI).
1321 By default DFS is enabled according to the regulatory definitions
1323 .Pa /etc/regdomain.xml
1324 and the current country code, regdomain,
1326 Note the underlying device (and driver) must support radar detection
1327 for full DFS support to work.
1328 To be fully compliant with the local regulatory agency frequencies that
1329 require DFS should not be used unless it is fully supported.
1332 to disable this functionality for testing.
1334 Enable support for the 802.11d specification (default).
1335 When this support is enabled in station mode, beacon frames that advertise
1336 a country code different than the currently configured country code will
1337 cause an event to be dispatched to user applications.
1338 This event can be used by the station to adopt that country code and
1339 operate according to the associated regulatory constraints.
1340 When operating as an access point with 802.11d enabled the beacon and
1341 probe response frames transmitted will advertise the current regulatory
1343 To disable 802.11d use
1346 Enable 802.11h support including spectrum management.
1347 When 802.11h is enabled beacon and probe response frames will have
1348 the SpectrumMgt bit set in the capabilities field and
1349 country and power constraint information elements will be present.
1350 802.11h support also includes handling Channel Switch Announcements (CSA)
1351 which are a mechanism to coordinate channel changes by an access point.
1352 By default 802.11h is enabled if the device is capable.
1353 To disable 802.11h use
1355 .It Cm deftxkey Ar index
1356 Set the default key to use for transmission.
1357 Typically this is only set when using WEP encryption.
1358 Note that you must set a default transmit key
1359 for the system to know which key to use in encrypting outbound traffic.
1362 is an alias for this request; it is provided for backwards compatibility.
1363 .It Cm dtimperiod Ar period
1366 period for transmitting buffered multicast data frames when
1367 operating in ap mode.
1370 specifies the number of beacon intervals between DTIM
1371 and must be in the range 1 to 15.
1372 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1374 Enable the use of quiet IE.
1375 Hostap will use this to silence other
1376 stations to reduce interference for radar detection when
1377 operating on 5GHz frequency and doth support is enabled.
1380 to disable this functionality.
1381 .It Cm quiet_period Ar period
1384 to the number of beacon intervals between the start of regularly
1385 scheduled quiet intervals defined by Quiet element.
1386 .It Cm quiet_count Ar count
1389 to the number of TBTTs until the beacon interval during which the
1390 next quiet interval shall start.
1391 A value of 1 indicates the quiet
1392 interval will start during the beacon interval starting at the next
1394 A value 0 is reserved.
1395 .It Cm quiet_offset Ar offset
1398 to the offset of the start of the quiet interval from the TBTT
1399 specified by the Quiet count, expressed in TUs.
1402 shall be less than one beacon interval.
1403 .It Cm quiet_duration Ar dur
1406 to the duration of the Quiet interval, expressed in TUs.
1407 The value should be less than beacon interval.
1409 Enable the use of Atheros Dynamic Turbo mode when communicating with
1410 another Dynamic Turbo-capable station.
1411 Dynamic Turbo mode is an Atheros-specific mechanism by which
1412 stations switch between normal 802.11 operation and a
1414 mode in which a 40MHz wide channel is used for communication.
1415 Stations using Dynamic Turbo mode operate boosted only when the
1416 channel is free of non-dturbo stations; when a non-dturbo station
1417 is identified on the channel all stations will automatically drop
1418 back to normal operation.
1419 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1420 Note that turbo mode (dynamic or static) is only allowed on some
1421 channels depending on the regulatory constraints; use the
1423 command to identify the channels where turbo mode may be used.
1424 To disable Dynamic Turbo mode use
1427 Enable Dynamic WDS (DWDS) support.
1428 DWDS is a facility by which 4-address traffic can be carried between
1429 stations operating in infrastructure mode.
1430 A station first associates to an access point and authenticates using
1431 normal procedures (e.g., WPA).
1432 Then 4-address frames are passed to carry traffic for stations
1433 operating on either side of the wireless link.
1434 DWDS extends the normal WDS mechanism by leveraging existing security
1435 protocols and eliminating static binding.
1437 When DWDS is enabled on an access point 4-address frames received from
1438 an authorized station will generate a
1442 This event should be used to create a WDS interface that is bound
1443 to the remote station (and usually plumbed into a bridge).
1444 Once the WDS interface is up and running 4-address traffic then logically
1445 flows through that interface.
1447 When DWDS is enabled on a station, traffic with a destination address
1448 different from the peer station are encapsulated in a 4-address frame
1449 and transmitted to the peer.
1450 All 4-address traffic uses the security information of the stations
1451 (e.g., cryptographic keys).
1452 A station is associated using 802.11n facilities may transport
1453 4-address traffic using these same mechanisms; this depends on available
1454 resources and capabilities of the device.
1455 The DWDS implementation guards against layer 2 routing loops of
1458 Enable the use of Atheros Fast Frames when communicating with
1459 another Fast Frames-capable station.
1460 Fast Frames are an encapsulation technique by which two 802.3
1461 frames are transmitted in a single 802.11 frame.
1462 This can noticeably improve throughput but requires that the
1463 receiving station understand how to decapsulate the frame.
1464 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1465 protocol extension so enabling use is safe when communicating with
1466 non-Atheros devices.
1467 By default, use of fast frames is enabled if the device is capable.
1468 To explicitly disable fast frames, use
1470 .It Cm fragthreshold Ar length
1471 Set the threshold for which transmitted frames are broken into fragments.
1474 argument is the frame size in bytes and must be in the range 256 to 2346.
1482 disables transmit fragmentation.
1483 Not all adapters honor the fragmentation threshold.
1485 When operating as an access point, do not broadcast the SSID
1486 in beacon frames or respond to probe request frames unless
1487 they are directed to the ap (i.e., they include the ap's SSID).
1488 By default, the SSID is included in beacon frames and
1489 undirected probe request frames are answered.
1490 To re-enable the broadcast of the SSID etc., use
1493 Enable use of High Throughput (HT) when using 802.11n (default).
1494 The 802.11n specification includes mechanisms for operation
1495 on 20MHz and 40MHz wide channels using different signalling mechanisms
1496 than specified in 802.11b, 802.11g, and 802.11a.
1497 Stations negotiate use of these facilities, termed HT20 and HT40,
1498 when they associate.
1499 To disable all use of 802.11n use
1501 To disable use of HT20 (e.g., to force only HT40 use) use
1503 To disable use of HT40 use
1506 HT configuration is used to
1509 when several choices are available.
1510 For example, if a station associates to an 11n-capable access point
1511 it controls whether the station uses legacy operation, HT20, or HT40.
1512 When an 11n-capable device is setup as an access point and
1513 Auto Channel Selection is used to locate a channel to operate on,
1514 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1515 on the selected channel.
1516 If a fixed channel is specified for a station then HT configuration can
1517 be given as part of the channel specification; e.g., 6:ht/20 to setup
1518 HT20 operation on channel 6.
1520 Enable use of compatibility support for pre-802.11n devices (default).
1521 The 802.11n protocol specification went through several incompatible iterations.
1522 Some vendors implemented 11n support to older specifications that
1523 will not interoperate with a purely 11n-compliant station.
1524 In particular the information elements included in management frames
1525 for old devices are different.
1526 When compatibility support is enabled both standard and compatible data
1528 Stations that associate using the compatibility mechanisms are flagged
1531 To disable compatibility support use
1533 .It Cm htprotmode Ar technique
1534 For interfaces operating in 802.11n, use the specified
1536 for protecting HT frames in a mixed legacy/HT network.
1537 The set of valid techniques is
1542 Technique names are case insensitive.
1544 Enable inactivity processing for stations associated to an
1545 access point (default).
1546 When operating as an access point the 802.11 layer monitors
1547 the activity of each associated station.
1548 When a station is inactive for 5 minutes it will send several
1550 to see if the station is still present.
1551 If no response is received then the station is deauthenticated.
1552 Applications that prefer to handle this work can disable this
1556 Set the location to use in calculating regulatory constraints.
1557 The location is also advertised in beacon and probe response frames
1558 when 802.11d is enabled with
1567 Display the list of channels available for use taking into account
1568 any restrictions set with the
1571 See the description of
1573 for more information.
1575 Display the adaptor's capabilities, including the operating
1578 Display the list of channels available for use.
1579 Channels are shown with their IEEE channel number, equivalent
1580 frequency, and usage modes.
1581 Channels identified as
1586 Channels identified as
1588 may be used only for Atheros' Static Turbo mode
1590 . Cm mediaopt turbo ) .
1591 Channels marked with a
1593 have a regulatory constraint that they be passively scanned.
1594 This means a station is not permitted to transmit on the channel until
1595 it identifies the channel is being used for 802.11 communication;
1596 typically by hearing a beacon frame from an access point operating
1599 is another way of requesting this information.
1600 By default a compacted list of channels is displayed; if the
1602 option is specified then all channels are shown.
1603 .It Cm list countries
1604 Display the set of country codes and regulatory domains that can be
1605 used in regulatory configuration.
1607 Display the current MAC Access Control List state.
1608 Each address is prefixed with a character that indicates the
1609 current policy applied to it:
1611 indicates the address is allowed access,
1613 indicates the address is denied access,
1615 indicates the address is present but the current policy open
1616 (so the ACL is not consulted).
1618 Displays the mesh routing table, used for forwarding packets on a mesh
1620 .It Cm list regdomain
1621 Display the current regulatory settings including the available channels
1622 and transmit power caps.
1624 Display the parameters that govern roaming operation.
1626 Display the parameters that govern transmit operation.
1628 Display the transmit power caps for each channel.
1630 Display the access points and/or ad-hoc neighbors
1631 located in the vicinity.
1632 This information may be updated automatically by the adapter
1635 request or through background scanning.
1636 Depending on the capabilities of the stations the following
1637 flags (capability codes) can be included in the output:
1644 Poll request capability.
1646 DSSS/OFDM capability.
1648 Extended Service Set (ESS).
1649 Indicates that the station is part of an infrastructure network
1650 rather than an IBSS/ad-hoc network.
1652 Independent Basic Service Set (IBSS).
1653 Indicates that the station is part of an ad-hoc network
1654 rather than an ESS network.
1657 The station requires authentication and encryption
1658 for all data frames exchanged within the BSS using cryptographic means
1659 such as WEP, TKIP, or AES-CCMP.
1661 Robust Secure Network (RSN).
1664 Indicates that the network is using short preambles,
1665 defined in 802.11b High Rate/DSSS PHY,
1666 and utilizes a 56 bit sync field
1667 rather than the 128 bit field used in long preamble mode.
1668 Short preambles are used to optionally
1669 improve throughput performance with 802.11g and 802.11b.
1671 Pollable capability.
1673 Short slot time capability.
1674 Indicates that the 802.11g network is using a short slot time
1675 because there are no legacy (802.11b) stations present.
1678 By default interesting information elements captured from the neighboring
1679 stations are displayed at the end of each row.
1680 Possible elements include:
1682 (station supports WME),
1684 (station supports WPA),
1686 (station supports WPS),
1688 (station supports 802.11i/RSN),
1690 (station supports 802.11n/HT communication),
1692 (station supports Atheros protocol extensions),
1694 (station supports unknown vendor-specific extensions).
1697 flag is used all the information elements and their
1698 contents will be shown.
1701 flag also enables display of long SSIDs.
1704 command is another way of requesting this information.
1706 When operating as an access point display the stations that are
1707 currently associated.
1708 When operating in ad-hoc mode display stations identified as
1709 neighbors in the IBSS.
1710 When operating in mesh mode display stations identified as
1711 neighbors in the MBSS.
1712 When operating in station mode display the access point.
1713 Capabilities advertised by the stations are described under
1717 The following flags can be included in the output:
1721 Indicates that the station is permitted to send/receive data frames.
1723 Extended Rate Phy (ERP).
1724 Indicates that the station is operating in an 802.11g network
1725 using extended transmit rates.
1727 High Throughput (HT).
1728 Indicates that the station is using HT transmit rates.
1731 follows immediately after then the station associated
1732 using deprecated mechanisms supported only when
1737 Indicates that the station is operating in power save mode.
1739 Quality of Service (QoS).
1740 Indicates that the station is using QoS encapsulation for
1742 QoS encapsulation is enabled only when WME mode is enabled.
1744 Short GI in HT 40MHz mode enabled.
1747 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1749 Transitional Security Network (TSN).
1750 Indicates that the station associated using TSN; see also
1754 Wi-Fi Protected Setup (WPS).
1755 Indicates that the station associated using WPS.
1757 Short GI in HT 20MHz mode enabled.
1760 By default information elements received from associated stations
1761 are displayed in a short form; the
1763 flag causes this information to be displayed symbolically.
1765 Display the current channel parameters to use when operating in WME mode.
1768 option is specified then both channel and BSS parameters are displayed
1769 for each AC (first channel, then BSS).
1770 When WME mode is enabled for an adaptor this information will be
1771 displayed with the regular status; this command is mostly useful
1772 for examining parameters when WME mode is disabled.
1773 See the description of the
1775 directive for information on the various parameters.
1776 .It Cm maxretry Ar count
1777 Set the maximum number of tries to use in sending unicast frames.
1778 The default setting is 6 but drivers may override this with a value
1780 .It Cm mcastrate Ar rate
1781 Set the rate for transmitting multicast/broadcast frames.
1782 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1783 This rate should be valid for the current operating conditions;
1784 if an invalid rate is specified drivers are free to chose an
1786 .It Cm mgtrate Ar rate
1787 Set the rate for transmitting management and/or control frames.
1788 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1790 Set the location to use in calculating regulatory constraints.
1791 The location is also advertised in beacon and probe response frames
1792 when 802.11d is enabled with
1801 Enable powersave operation.
1802 When operating as a client, the station will conserve power by
1803 periodically turning off the radio and listening for
1804 messages from the access point telling it there are packets waiting.
1805 The station must then retrieve the packets.
1806 Not all devices support power save operation as a client.
1807 The 802.11 specification requires that all access points support
1808 power save but some drivers do not.
1811 to disable powersave operation when operating as a client.
1812 .It Cm powersavesleep Ar sleep
1813 Set the desired max powersave sleep time in TU's (1024 usecs).
1814 By default the max powersave sleep time is 100 TU's.
1815 .It Cm protmode Ar technique
1816 For interfaces operating in 802.11g, use the specified
1818 for protecting OFDM frames in a mixed 11b/11g network.
1819 The set of valid techniques is
1825 Technique names are case insensitive.
1826 Not all devices support
1828 as a protection technique.
1830 When operating as an access point in 802.11g mode allow only
1831 11g-capable stations to associate (11b-only stations are not
1832 permitted to associate).
1833 To allow both 11g and 11b-only stations to associate, use
1836 When operating as an access point in 802.11n mode allow only
1837 HT-capable stations to associate (legacy stations are not
1838 permitted to associate).
1839 To allow both HT and legacy stations to associate, use
1841 .It Cm regdomain Ar sku
1842 Set the regulatory domain to use in calculating the regulatory constraints
1844 In particular the set of available channels, how the wireless device
1845 will operation on the channels, and the maximum transmit power that
1846 can be used on a channel are defined by this setting.
1847 Regdomain codes (SKU's) are taken from
1848 .Pa /etc/regdomain.xml
1853 Note that not all devices support changing the regdomain from a default
1854 setting; typically stored in EEPROM.
1862 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1864 Note that RIFS must be supported by both the station and access point
1868 .It Cm roam:rate Ar rate
1869 Set the threshold for controlling roaming when operating in a BSS.
1872 parameter specifies the transmit rate in megabits
1873 at which roaming should be considered.
1874 If the current transmit rate drops below this setting and background scanning
1875 is enabled, then the system will check if a more desirable access point is
1876 available and switch over to it.
1877 The current scan cache contents are used if they are considered
1878 valid according to the
1880 parameter; otherwise a background scan operation is triggered before
1881 any selection occurs.
1882 Each channel type has a separate rate threshold; the default values are:
1883 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1884 .It Cm roam:rssi Ar rssi
1885 Set the threshold for controlling roaming when operating in a BSS.
1888 parameter specifies the receive signal strength in dBm units
1889 at which roaming should be considered.
1890 If the current rssi drops below this setting and background scanning
1891 is enabled, then the system will check if a more desirable access point is
1892 available and switch over to it.
1893 The current scan cache contents are used if they are considered
1894 valid according to the
1896 parameter; otherwise a background scan operation is triggered before
1897 any selection occurs.
1898 Each channel type has a separate rssi threshold; the default values are
1900 .It Cm roaming Ar mode
1901 When operating as a station, control how the system will
1902 behave when communication with the current access point
1906 argument may be one of
1908 (leave it to the hardware device to decide),
1910 (handle either in the device or the operating system\[em]as appropriate),
1912 (do nothing until explicitly instructed).
1913 By default, the device is left to handle this if it is
1914 capable; otherwise, the operating system will automatically
1915 attempt to reestablish communication.
1916 Manual mode is used by applications such as
1917 .Xr wpa_supplicant 8
1918 that want to control the selection of an access point.
1919 .It Cm rtsthreshold Ar length
1920 Set the threshold for which
1921 transmitted frames are preceded by transmission of an
1927 is the frame size in bytes and must be in the range 1 to 2346.
1935 disables transmission of RTS frames.
1936 Not all adapters support setting the RTS threshold.
1938 Initiate a scan of neighboring stations, wait for it to complete, and
1939 display all stations found.
1940 Only the super-user can initiate a scan.
1943 for information on the display.
1944 By default a background scan is done; otherwise a foreground
1945 scan is done and the station may roam to a different access point.
1948 request can be used to show recent scan results without
1949 initiating a new scan.
1950 .It Cm scanvalid Ar threshold
1951 Set the maximum time the scan cache contents are considered valid;
1952 i.e., will be used without first triggering a scan operation to
1956 parameter is specified in seconds and defaults to 60 seconds.
1957 The minimum setting for
1960 One should take care setting this threshold; if it is set too low
1961 then attempts to roam to another access point may trigger unnecessary
1962 background scan operations.
1964 Enable use of Short Guard Interval when operating in 802.11n
1966 NB: this currently enables Short GI on both HT40 and HT20 channels.
1967 To disable Short GI use
1970 Enable use of Static Spatial Multiplexing Power Save (SMPS)
1971 when operating in 802.11n.
1972 A station operating with Static SMPS maintains only a single
1973 receive chain active (this can significantly reduce power consumption).
1977 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
1978 when operating in 802.11n.
1979 A station operating with Dynamic SMPS maintains only a single
1980 receive chain active but switches to multiple receive chains when it
1981 receives an RTS frame (this can significantly reduce power consumption).
1982 Note that stations cannot distinguish between RTS/CTS intended to
1983 enable multiple receive chains and those used for other purposes.
1987 Set the desired Service Set Identifier (aka network name).
1988 The SSID is a string up to 32 characters
1989 in length and may be specified as either a normal string or in
1990 hexadecimal when preceded by
1992 Additionally, the SSID may be cleared by setting it to
1994 .It Cm tdmaslot Ar slot
1995 When operating with TDMA, use the specified
2000 is a number between 0 and the maximum number of slots in the BSS.
2001 Note that a station configured as slot 0 is a master and
2002 will broadcast beacon frames advertising the BSS;
2003 stations configured to use other slots will always
2004 scan to locate a master before they ever transmit.
2008 .It Cm tdmaslotcnt Ar cnt
2009 When operating with TDMA, setup a BSS with
2012 The slot count may be at most 8.
2013 The current implementation is only tested with two stations
2014 (i.e., point to point applications).
2015 This setting is only meaningful when a station is configured as slot 0;
2016 other stations adopt this setting from the BSS they join.
2020 .It Cm tdmaslotlen Ar len
2021 When operating with TDMA, setup a BSS such that each station has a slot
2024 The slot length must be at least 150 microseconds (1/8 TU)
2025 and no more than 65 milliseconds.
2026 Note that setting too small a slot length may result in poor channel
2027 bandwidth utilization due to factors such as timer granularity and
2029 This setting is only meaningful when a station is configured as slot 0;
2030 other stations adopt this setting from the BSS they join.
2033 is set to 10 milliseconds.
2034 .It Cm tdmabintval Ar intval
2035 When operating with TDMA, setup a BSS such that beacons are transmitted every
2037 superframes to synchronize the TDMA slot timing.
2038 A superframe is defined as the number of slots times the slot length; e.g.,
2039 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
2040 The beacon interval may not be zero.
2043 causes the timers to be resynchronized more often; this can be help if
2044 significant timer drift is observed.
2049 When operating as an access point with WPA/802.11i allow legacy
2050 stations to associate using static key WEP and open authentication.
2051 To disallow legacy station use of WEP, use
2053 .It Cm txpower Ar power
2054 Set the power used to transmit frames.
2057 argument is specified in .5 dBm units.
2058 Out of range values are truncated.
2059 Typically only a few discreet power settings are available and
2060 the driver will use the setting closest to the specified value.
2061 Not all adapters support changing the transmit power.
2062 .It Cm ucastrate Ar rate
2063 Set a fixed rate for transmitting unicast frames.
2064 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
2065 This rate should be valid for the current operating conditions;
2066 if an invalid rate is specified drivers are free to chose an
2068 .It Cm wepmode Ar mode
2069 Set the desired WEP mode.
2070 Not all adapters support all modes.
2071 The set of valid modes is
2077 mode explicitly tells the adaptor to allow association with access
2078 points which allow both encrypted and unencrypted traffic.
2081 means that the access point must only allow encrypted connections.
2084 is generally another name for
2086 Modes are case insensitive.
2087 .It Cm weptxkey Ar index
2088 Set the WEP key to be used for transmission.
2089 This is the same as setting the default transmission key with
2091 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
2092 Set the selected WEP key.
2095 is not given, key 1 is set.
2096 A WEP key will be either 5 or 13
2097 characters (40 or 104 bits) depending on the local network and the
2098 capabilities of the adaptor.
2099 It may be specified either as a plain
2100 string or as a string of hexadecimal digits preceded by
2102 For maximum portability, hex keys are recommended;
2103 the mapping of text keys to WEP encryption is usually driver-specific.
2104 In particular, the Windows drivers do this mapping differently to
2106 A key may be cleared by setting it to
2108 If WEP is supported then there are at least four keys.
2109 Some adapters support more than four keys.
2110 If that is the case, then the first four keys
2111 (1-4) will be the standard temporary keys and any others will be adaptor
2112 specific keys such as permanent keys stored in NVRAM.
2114 Note that you must set a default transmit key with
2116 for the system to know which key to use in encrypting outbound traffic.
2118 Enable Wireless Multimedia Extensions (WME) support, if available,
2119 for the specified interface.
2120 WME is a subset of the IEEE 802.11e standard to support the
2121 efficient communication of realtime and multimedia data.
2122 To disable WME support, use
2124 Another name for this parameter is
2127 The following parameters are meaningful only when WME support is in use.
2128 Parameters are specified per-AC (Access Category) and
2129 split into those that are used by a station when acting
2130 as an access point and those for client stations in the BSS.
2131 The latter are received from the access point and may not be changed
2133 The following Access Categories are recognized:
2135 .Bl -tag -width ".Cm AC_BK" -compact
2139 best effort delivery,
2154 AC parameters are case-insensitive.
2155 Traffic classification is done in the operating system using the
2156 vlan priority associated with data frames or the
2157 ToS (Type of Service) indication in IP-encapsulated frames.
2158 If neither information is present, traffic is assigned to the
2159 Best Effort (BE) category.
2160 .Bl -tag -width indent
2162 Set the ACK policy for QoS transmissions by the local station;
2163 this controls whether or not data frames transmitted by a station
2164 require an ACK response from the receiving station.
2165 To disable waiting for an ACK use
2167 This parameter is applied only to the local station.
2169 Enable the Admission Control Mandatory (ACM) mechanism
2170 for transmissions by the local station.
2171 To disable the ACM use
2173 On stations in a BSS this parameter is read-only and indicates
2174 the setting received from the access point.
2175 NB: ACM is not supported right now.
2176 .It Cm aifs Ar ac Ar count
2177 Set the Arbitration Inter Frame Spacing (AIFS)
2178 channel access parameter to use for transmissions
2179 by the local station.
2180 On stations in a BSS this parameter is read-only and indicates
2181 the setting received from the access point.
2182 .It Cm cwmin Ar ac Ar count
2183 Set the CWmin channel access parameter to use for transmissions
2184 by the local station.
2185 On stations in a BSS this parameter is read-only and indicates
2186 the setting received from the access point.
2187 .It Cm cwmax Ar ac Ar count
2188 Set the CWmax channel access parameter to use for transmissions
2189 by the local station.
2190 On stations in a BSS this parameter is read-only and indicates
2191 the setting received from the access point.
2192 .It Cm txoplimit Ar ac Ar limit
2193 Set the Transmission Opportunity Limit channel access parameter
2194 to use for transmissions by the local station.
2195 This parameter defines an interval of time when a WME station
2196 has the right to initiate transmissions onto the wireless medium.
2197 On stations in a BSS this parameter is read-only and indicates
2198 the setting received from the access point.
2199 .It Cm bss:aifs Ar ac Ar count
2200 Set the AIFS channel access parameter to send to stations in a BSS.
2201 This parameter is meaningful only when operating in ap mode.
2202 .It Cm bss:cwmin Ar ac Ar count
2203 Set the CWmin channel access parameter to send to stations in a BSS.
2204 This parameter is meaningful only when operating in ap mode.
2205 .It Cm bss:cwmax Ar ac Ar count
2206 Set the CWmax channel access parameter to send to stations in a BSS.
2207 This parameter is meaningful only when operating in ap mode.
2208 .It Cm bss:txoplimit Ar ac Ar limit
2209 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2210 This parameter is meaningful only when operating in ap mode.
2213 Enable Wireless Privacy Subscriber support.
2214 Note that WPS support requires a WPS-capable supplicant.
2215 To disable this function use
2218 .Ss MAC-Based Access Control List Parameters
2219 The following parameters support an optional access control list
2220 feature available with some adapters when operating in ap mode; see
2222 This facility allows an access point to accept/deny association
2223 requests based on the MAC address of the station.
2224 Note that this feature does not significantly enhance security
2225 as MAC address spoofing is easy to do.
2226 .Bl -tag -width indent
2227 .It Cm mac:add Ar address
2228 Add the specified MAC address to the database.
2229 Depending on the policy setting association requests from the
2230 specified station will be allowed or denied.
2232 Set the ACL policy to permit association only by
2233 stations registered in the database.
2234 .It Cm mac:del Ar address
2235 Delete the specified MAC address from the database.
2237 Set the ACL policy to deny association only by
2238 stations registered in the database.
2239 .It Cm mac:kick Ar address
2240 Force the specified station to be deauthenticated.
2241 This typically is done to block a station after updating the
2244 Set the ACL policy to allow all stations to associate.
2246 Delete all entries in the database.
2248 Set the ACL policy to permit association only by
2249 stations approved by a RADIUS server.
2250 Note that this feature requires the
2252 program be configured to do the right thing
2253 as it handles the RADIUS processing
2254 (and marks stations as authorized).
2256 .Ss Mesh Mode Wireless Interface Parameters
2257 The following parameters are related to a wireless interface operating in mesh
2259 .Bl -tag -width indent
2260 .It Cm meshid Ar meshid
2261 Set the desired Mesh Identifier.
2262 The Mesh ID is a string up to 32 characters in length.
2263 A mesh interface must have a Mesh Identifier specified
2264 to reach an operational state.
2265 .It Cm meshttl Ar ttl
2268 for mesh forwarded packets;
2269 this is the number of hops a packet may be forwarded before
2271 The default setting for
2275 Enable or disable peering with neighbor mesh stations.
2276 Stations must peer before any data packets can be exchanged.
2281 Enable or disable forwarding packets by a mesh interface.
2286 This attribute specifies whether or not the mesh STA activates mesh gate
2291 .It Cm meshmetric Ar protocol
2294 as the link metric protocol used on a mesh network.
2295 The default protocol is called
2297 The mesh interface will restart after changing this setting.
2298 .It Cm meshpath Ar protocol
2301 as the path selection protocol used on a mesh network.
2302 The only available protocol at the moment is called
2304 (Hybrid Wireless Mesh Protocol).
2305 The mesh interface will restart after changing this setting.
2306 .It Cm hwmprootmode Ar mode
2307 Stations on a mesh network can operate as
2309 Root nodes try to find paths to all mesh nodes and advertise themselves
2311 When there is a root mesh node on a network, other mesh nodes can setup
2312 paths between themselves faster because they can use the root node
2313 to find the destination.
2314 This path may not be the best, but on-demand
2315 routing will eventually find the best path.
2316 The following modes are recognized:
2318 .Bl -tag -width ".Cm PROACTIVE" -compact
2322 Send broadcast path requests every two seconds.
2323 Nodes on the mesh without a path to this root mesh station with try to
2324 discover a path to us.
2326 Send broadcast path requests every two seconds and every node must reply
2327 with a path reply even if it already has a path to this root mesh station.
2329 Send broadcast root announcement (RANN) frames.
2330 Nodes on the mesh without a path to this root mesh station with try to
2331 discover a path to us.
2337 .It Cm hwmpmaxhops Ar cnt
2338 Set the maximum number of hops allowed in an HMWP path to
2340 The default setting for
2344 .Ss Compatibility Parameters
2345 The following parameters are for compatibility with other systems:
2346 .Bl -tag -width indent
2348 Another name for the
2354 .It Cm stationname Ar name
2355 Set the name of this station.
2356 The station name is not part of the IEEE 802.11
2357 protocol though some interfaces support it.
2359 seems to be meaningful to identical or virtually identical equipment.
2360 Setting the station name is identical in syntax to setting the SSID.
2367 Another way of saying
2373 Another way of saying
2379 Another way of saying:
2380 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2386 .Ar n : k1 , k2 , k3 , k4
2389 Another way of saying
2390 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2395 Another way of saying
2401 .Ss Bridge Interface Parameters
2402 The following parameters are specific to bridge interfaces:
2403 .Bl -tag -width indent
2404 .It Cm addm Ar interface
2405 Add the interface named by
2407 as a member of the bridge.
2408 The interface is put into promiscuous mode
2409 so that it can receive every packet sent on the network.
2410 .It Cm deletem Ar interface
2411 Remove the interface named by
2414 Promiscuous mode is disabled on the interface when
2415 it is removed from the bridge.
2416 .It Cm maxaddr Ar size
2417 Set the size of the bridge address cache to
2419 The default is 2000 entries.
2420 .It Cm timeout Ar seconds
2421 Set the timeout of address cache entries to
2426 is zero, then address cache entries will not be expired.
2427 The default is 1200 seconds.
2429 Display the addresses that have been learned by the bridge.
2430 .It Cm static Ar interface-name Ar address
2431 Add a static entry into the address cache pointing to
2432 .Ar interface-name .
2433 Static entries are never aged out of the cache or re-placed, even if the
2434 address is seen on a different interface.
2435 .It Cm deladdr Ar address
2438 from the address cache.
2440 Delete all dynamically-learned addresses from the address cache.
2442 Delete all addresses, including static addresses, from the address cache.
2443 .It Cm discover Ar interface
2444 Mark an interface as a
2447 When the bridge has no address cache entry
2448 (either dynamic or static)
2449 for the destination address of a packet,
2450 the bridge will forward the packet to all
2451 member interfaces marked as
2453 This is the default for all interfaces added to a bridge.
2454 .It Cm -discover Ar interface
2457 attribute on a member interface.
2458 For packets without the
2460 attribute, the only packets forwarded on the interface are broadcast
2461 or multicast packets and packets for which the destination address
2462 is known to be on the interface's segment.
2463 .It Cm learn Ar interface
2464 Mark an interface as a
2467 When a packet arrives on such an interface, the source
2468 address of the packet is entered into the address cache as being a
2469 destination address on the interface's segment.
2470 This is the default for all interfaces added to a bridge.
2471 .It Cm -learn Ar interface
2474 attribute on a member interface.
2475 .It Cm sticky Ar interface
2476 Mark an interface as a
2479 Dynamically learned address entries are treated at static once entered into
2481 Sticky entries are never aged out of the cache or replaced, even if the
2482 address is seen on a different interface.
2483 .It Cm -sticky Ar interface
2486 attribute on a member interface.
2487 .It Cm private Ar interface
2488 Mark an interface as a
2491 A private interface does not forward any traffic to any other port that is also
2492 a private interface.
2493 .It Cm -private Ar interface
2496 attribute on a member interface.
2497 .It Cm span Ar interface
2498 Add the interface named by
2500 as a span port on the bridge.
2501 Span ports transmit a copy of every frame received by the bridge.
2502 This is most useful for snooping a bridged network passively on
2503 another host connected to one of the span ports of the bridge.
2504 .It Cm -span Ar interface
2505 Delete the interface named by
2507 from the list of span ports of the bridge.
2508 .It Cm stp Ar interface
2509 Enable Spanning Tree protocol on
2513 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2514 Spanning Tree is used to detect and remove loops in a network topology.
2515 .It Cm -stp Ar interface
2516 Disable Spanning Tree protocol on
2518 This is the default for all interfaces added to a bridge.
2519 .It Cm edge Ar interface
2523 An edge port connects directly to end stations cannot create bridging
2524 loops in the network, this allows it to transition straight to forwarding.
2525 .It Cm -edge Ar interface
2526 Disable edge status on
2528 .It Cm autoedge Ar interface
2531 to automatically detect edge status.
2532 This is the default for all interfaces added to a bridge.
2533 .It Cm -autoedge Ar interface
2534 Disable automatic edge status on
2536 .It Cm ptp Ar interface
2539 as a point to point link.
2540 This is required for straight transitions to forwarding and
2541 should be enabled on a direct link to another RSTP capable switch.
2542 .It Cm -ptp Ar interface
2543 Disable point to point link status on
2545 This should be disabled for a half duplex link and for an interface
2546 connected to a shared network segment,
2547 like a hub or a wireless network.
2548 .It Cm autoptp Ar interface
2549 Automatically detect the point to point status on
2551 by checking the full duplex link status.
2552 This is the default for interfaces added to the bridge.
2553 .It Cm -autoptp Ar interface
2554 Disable automatic point to point link detection on
2556 .It Cm maxage Ar seconds
2557 Set the time that a Spanning Tree protocol configuration is valid.
2558 The default is 20 seconds.
2559 The minimum is 6 seconds and the maximum is 40 seconds.
2560 .It Cm fwddelay Ar seconds
2561 Set the time that must pass before an interface begins forwarding
2562 packets when Spanning Tree is enabled.
2563 The default is 15 seconds.
2564 The minimum is 4 seconds and the maximum is 30 seconds.
2565 .It Cm hellotime Ar seconds
2566 Set the time between broadcasting of Spanning Tree protocol
2567 configuration messages.
2568 The hello time may only be changed when operating in legacy stp mode.
2569 The default is 2 seconds.
2570 The minimum is 1 second and the maximum is 2 seconds.
2571 .It Cm priority Ar value
2572 Set the bridge priority for Spanning Tree.
2573 The default is 32768.
2574 The minimum is 0 and the maximum is 61440.
2575 .It Cm proto Ar value
2576 Set the Spanning Tree protocol.
2577 The default is rstp.
2578 The available options are stp and rstp.
2579 .It Cm holdcnt Ar value
2580 Set the transmit hold count for Spanning Tree.
2581 This is the number of packets transmitted before being rate limited.
2583 The minimum is 1 and the maximum is 10.
2584 .It Cm ifpriority Ar interface Ar value
2585 Set the Spanning Tree priority of
2590 The minimum is 0 and the maximum is 240.
2591 .It Cm ifpathcost Ar interface Ar value
2592 Set the Spanning Tree path cost of
2596 The default is calculated from the link speed.
2597 To change a previously selected path cost back to automatic, set the
2599 The minimum is 1 and the maximum is 200000000.
2600 .It Cm ifmaxaddr Ar interface Ar size
2601 Set the maximum number of hosts allowed from an interface, packets with unknown
2602 source addresses are dropped until an existing host cache entry expires or is
2604 Set to 0 to disable.
2606 .Ss Link Aggregation and Link Failover Parameters
2607 The following parameters are specific to lagg interfaces:
2608 .Bl -tag -width indent
2609 .It Cm laggtype Ar type
2610 When creating a lagg interface the type can be specified as either
2614 If not specified ethernet is the default lagg type.
2615 .It Cm laggport Ar interface
2616 Add the interface named by
2618 as a port of the aggregation interface.
2619 .It Cm -laggport Ar interface
2620 Remove the interface named by
2622 from the aggregation interface.
2623 .It Cm laggproto Ar proto
2624 Set the aggregation protocol.
2627 The available options are
2635 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2636 Set the packet layers to hash for aggregation protocols which load balance.
2639 The options can be combined using commas.
2641 .Bl -tag -width ".Cm l2" -compact
2643 src/dst mac address and optional vlan number.
2645 src/dst address for IPv4 or IPv6.
2647 src/dst port for TCP/UDP/SCTP.
2650 Enable local hash computation for RSS hash on the interface.
2655 modes will use the RSS hash from the network card if available
2656 to avoid computing one, this may give poor traffic distribution
2657 if the hash is invalid or uses less of the protocol header information.
2659 disables use of RSS hash from the network card.
2660 The default value can be set via the
2661 .Va net.link.lagg.default_use_flowid
2672 Use the RSS hash from the network card if available.
2673 .It Cm flowid_shift Ar number
2674 Set a shift parameter for RSS local hash computation.
2675 Hash is calculated by using flowid bits in a packet header mbuf
2676 which are shifted by the number of this parameter.
2678 Enable selection of egress ports based on the native
2680 domain for the packets being transmitted.
2681 This is currently only implemented for lacp mode.
2684 hardware, running a kernel compiled with the
2686 option, and when interfaces from multiple
2688 domains are ports of the aggregation interface.
2690 Disable selection of egress ports based on the native
2692 domain for the packets being transmitted.
2693 .It Cm lacp_fast_timeout
2694 Enable lacp fast-timeout on the interface.
2695 .It Cm -lacp_fast_timeout
2696 Disable lacp fast-timeout on the interface.
2698 Enable lacp strict compliance on the interface.
2699 The default value can be set via the
2700 .Va net.link.lagg.lacp.default_strict_mode
2711 Disable lacp strict compliance on the interface.
2712 .It Cm rr_limit Ar number
2713 Configure a stride for an interface in round-robin mode.
2714 The default stride is 1.
2716 .Ss Generic IP Tunnel Parameters
2717 The following parameters apply to IP tunnel interfaces,
2719 .Bl -tag -width indent
2720 .It Cm tunnel Ar src_addr dest_addr
2721 Configure the physical source and destination address for IP tunnel
2727 are interpreted as the outer source/destination for the encapsulating
2730 Unconfigure the physical source and destination address for IP tunnel
2731 interfaces previously configured with
2734 Another name for the
2737 .It Cm accept_rev_ethip_ver
2738 Set a flag to accept both correct EtherIP packets and ones
2739 with reversed version field.
2741 This is for backward compatibility with
2743 6.2, 6.3, 7.0, and 7.1.
2744 .It Cm -accept_rev_ethip_ver
2746 .Cm accept_rev_ethip_ver .
2747 .It Cm ignore_source
2748 Set a flag to accept encapsulated packets destined to this host
2749 independently from source address.
2750 This may be useful for hosts, that receive encapsulated packets
2751 from the load balancers.
2752 .It Cm -ignore_source
2755 .It Cm send_rev_ethip_ver
2756 Set a flag to send EtherIP packets with reversed version
2757 field intentionally.
2758 Disabled by default.
2759 This is for backward compatibility with
2761 6.2, 6.3, 7.0, and 7.1.
2762 .It Cm -send_rev_ethip_ver
2764 .Cm send_rev_ethip_ver .
2766 .Ss GRE Tunnel Parameters
2767 The following parameters apply to GRE tunnel interfaces,
2769 .Bl -tag -width indent
2770 .It Cm tunnel Ar src_addr dest_addr
2771 Configure the physical source and destination address for GRE tunnel
2777 are interpreted as the outer source/destination for the encapsulating
2780 Unconfigure the physical source and destination address for GRE tunnel
2781 interfaces previously configured with
2784 Another name for the
2787 .It Cm grekey Ar key
2788 Configure the GRE key to be used for outgoing packets.
2790 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2791 This command will result in a four byte MTU reduction on the interface.
2793 .Ss Packet Filter State Table Sychronisation Parameters
2794 The following parameters are specific to
2797 .Bl -tag -width indent
2798 .It Cm syncdev Ar iface
2799 Use the specified interface
2800 to send and receive pfsync state synchronisation messages.
2802 Stop sending pfsync state synchronisation messages over the network.
2803 .It Cm syncpeer Ar peer_address
2804 Make the pfsync link point-to-point rather than using
2805 multicast to broadcast the state synchronisation messages.
2806 The peer_address is the IP address of the other host taking part in
2809 Broadcast the packets using multicast.
2811 Set the maximum number of updates for a single state which
2812 can be collapsed into one.
2813 This is an 8-bit number; the default value is 128.
2815 Defer transmission of the first packet in a state until a peer has
2816 acknowledged that the associated state has been inserted.
2818 Do not defer the first packet in a state.
2819 This is the default.
2822 The following parameters are specific to
2825 .Bl -tag -width indent
2826 .It Cm vlan Ar vlan_tag
2827 Set the VLAN tag value to
2829 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2830 or 802.1ad VLAN header for packets sent from the
2837 must both be set at the same time.
2838 .It Cm vlanproto Ar vlan_proto
2839 Set the VLAN encapsulation protocol to
2841 Supported encapsulation protocols are currently
2845 The default encapsulation protocol is
2849 protocol is also commonly known as
2851 either name can be used.
2852 .It Cm vlanpcp Ar priority_code_point
2855 is an 3-bit field which refers to the IEEE 802.1p
2856 class of service and maps to the frame priority level.
2858 Values in order of priority are:
2860 .Pq Dv Background (lowest) ,
2862 .Pq Dv Best effort (default) ,
2864 .Pq Dv Excellent effort ,
2866 .Pq Dv Critical applications ,
2868 .Pq Dv Video, < 100ms latency and jitter ,
2870 .Pq Dv Voice, < 10ms latency and jitter ,
2872 .Pq Dv Internetwork control ,
2874 .Pq Dv Network control (highest) .
2875 .It Cm vlandev Ar iface
2876 Associate the physical interface
2881 Packets transmitted through the
2884 diverted to the specified physical interface
2886 with 802.1Q VLAN encapsulation.
2887 Packets with 802.1Q encapsulation received
2888 by the parent interface with the correct VLAN Identifier will be diverted to
2894 interface is assigned a
2895 copy of the parent interface's flags and the parent's Ethernet address.
2900 must both be set at the same time.
2903 interface already has
2904 a physical interface associated with it, this command will fail.
2906 change the association to another physical interface, the existing
2907 association must be cleared first.
2909 Note: if the hardware tagging capability
2910 is set on the parent interface, the
2913 interface's behavior changes:
2916 interface recognizes that the
2917 parent interface supports insertion and extraction of VLAN tags on its
2918 own (usually in firmware) and that it should pass packets to and from
2919 the parent unaltered.
2920 .It Fl vlandev Op Ar iface
2923 pseudo device, disassociate the parent interface from it.
2924 This breaks the link between the
2926 interface and its parent,
2927 clears its VLAN Identifier, flags and its link address and shuts the interface
2931 argument is useless and hence deprecated.
2933 .Ss Virtual eXtensible LAN Parameters
2934 The following parameters are used to configure
2937 .Bl -tag -width indent
2938 .It Cm vxlanid Ar identifier
2939 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2940 virtual network segment membership of the interface.
2941 .It Cm vxlanlocal Ar address
2942 The source address used in the encapsulating IPv4/IPv6 header.
2943 The address should already be assigned to an existing interface.
2944 When the interface is configured in unicast mode, the listening socket
2945 is bound to this address.
2946 .It Cm vxlanremote Ar address
2947 The interface can be configured in a unicast, or point-to-point, mode
2948 to create a tunnel between two hosts.
2949 This is the IP address of the remote end of the tunnel.
2950 .It Cm vxlangroup Ar address
2951 The interface can be configured in a multicast mode
2952 to create a virtual network of hosts.
2953 This is the IP multicast group address the interface will join.
2954 .It Cm vxlanlocalport Ar port
2955 The port number the interface will listen on.
2956 The default port number is 4789.
2957 .It Cm vxlanremoteport Ar port
2958 The destination port number used in the encapsulating IPv4/IPv6 header.
2959 The remote host should be listening on this port.
2960 The default port number is 4789.
2961 Note some other implementations, such as Linux,
2962 do not default to the IANA assigned port,
2963 but instead listen on port 8472.
2964 .It Cm vxlanportrange Ar low high
2965 The range of source ports used in the encapsulating IPv4/IPv6 header.
2966 The port selected within the range is based on a hash of the inner frame.
2967 A range is useful to provide entropy within the outer IP header
2968 for more effective load balancing.
2969 The default range is between the
2972 .Va net.inet.ip.portrange.first
2974 .Va net.inet.ip.portrange.last
2975 .It Cm vxlantimeout Ar timeout
2976 The maximum time, in seconds, before an entry in the forwarding table
2978 The default is 1200 seconds (20 minutes).
2979 .It Cm vxlanmaxaddr Ar max
2980 The maximum number of entries in the forwarding table.
2981 The default is 2000.
2982 .It Cm vxlandev Ar dev
2983 When the interface is configured in multicast mode, the
2985 interface is used to transmit IP multicast packets.
2986 .It Cm vxlanttl Ar ttl
2987 The TTL used in the encapsulating IPv4/IPv6 header.
2990 The source IP address and inner source Ethernet MAC address of
2991 received packets are used to dynamically populate the forwarding table.
2992 When in multicast mode, an entry in the forwarding table allows the
2993 interface to send the frame directly to the remote host instead of
2994 broadcasting the frame to the multicast group.
2995 This is the default.
2997 The forwarding table is not populated by received packets.
2999 Delete all dynamically-learned addresses from the forwarding table.
3000 .It Cm vxlanflushall
3001 Delete all addresses, including static addresses, from the forwarding table.
3004 The following parameters are used to configure
3006 protocol on an interface:
3007 .Bl -tag -width indent
3009 Set the virtual host ID.
3010 This is a required setting to initiate
3012 If the virtual host ID does not exist yet, it is created and attached to the
3013 interface, otherwise configuration of an existing vhid is adjusted.
3016 keyword is supplied along with an
3020 address, then this address is configured to be run under control of the
3022 Whenever a last address that refers to a particular vhid is removed from an
3023 interface, the vhid is automatically removed from interface and destroyed.
3024 Any other configuration parameters for the
3026 protocol should be supplied along with the
3029 Acceptable values for vhid are 1 to 255.
3030 .It Cm advbase Ar seconds
3031 Specifies the base of the advertisement interval in seconds.
3032 The acceptable values are 1 to 255.
3033 The default value is 1.
3034 .It Cm advskew Ar interval
3035 Specifies the skew to add to the base advertisement interval to
3036 make one host advertise slower than another host.
3037 It is specified in 1/256 of seconds.
3038 The acceptable values are 1 to 254.
3039 The default value is 0.
3040 .It Cm pass Ar phrase
3041 Set the authentication key to
3043 .It Cm state Ar state
3044 Forcibly change state of a given vhid.
3045 The following states are recognized:
3051 The following environment variables affect the execution of
3053 .Bl -tag -width IFCONFIG_FORMAT
3054 .It Ev IFCONFIG_FORMAT
3055 This variable can contain a specification of the output format.
3056 See the description of the
3058 flag for more details.
3061 Assign the IPv4 address
3063 with a network mask of
3067 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3069 Add the IPv4 address
3071 with the CIDR network prefix
3075 .Dl # ifconfig em0 inet 192.0.2.45/28 alias
3077 Remove the IPv4 address
3081 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3083 Enable IPv6 functionality of the interface:
3084 .Dl # ifconfig em0 inet6 -ifdisabled
3086 Add the IPv6 address
3087 .Li 2001:DB8:DBDB::123/48
3090 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3091 Note that lower case hexadecimal IPv6 addresses are acceptable.
3093 Remove the IPv6 address added in the above example,
3096 character as shorthand for the network prefix:
3097 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 -alias
3099 Configure a single CARP redundant address on igb0, and then switch it
3101 .Bd -literal -offset indent -compact
3102 # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3103 # ifconfig igb0 vhid 1 state master
3106 Configure the interface
3108 to use 100baseTX, full duplex Ethernet media options:
3109 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3111 Label the em0 interface as an uplink:
3112 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3114 Create the software network interface
3116 .Dl # ifconfig gif1 create
3118 Destroy the software network interface
3120 .Dl # ifconfig gif1 destroy
3122 Display available wireless networks using
3124 .Dl # ifconfig wlan0 list scan
3126 Display inet and inet6 address subnet masks in CIDR notation
3127 .Dl # ifconfig -f inet:cidr,inet6:cidr
3129 Display interfaces that are up with the exception of loopback
3130 .Dl # ifconfig -a -u -G lo
3132 Set a randomly-generated MAC address on tap0:
3133 .Dl # ifconfig tap0 ether random
3135 Messages indicating the specified interface does not exist, the
3136 requested address is unknown, or the user is not privileged and
3137 tried to alter an interface's configuration.
3159 Basic IPv6 node operation requires a link-local address on each
3160 interface configured for IPv6.
3161 Normally, such an address is automatically configured by the
3162 kernel on each interface added to the system or enabled; this behavior may
3163 be disabled by setting per-interface flag
3164 .Cm -auto_linklocal .
3165 The default value of this flag is 1 and can be disabled by using the sysctl
3167 .Va net.inet6.ip6.auto_linklocal .
3169 Do not configure IPv6 addresses with no link-local address by using
3171 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob