1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)ifconfig.8 8.3 (Berkeley) 1/5/94
36 .Nd configure network interface parameters
40 .Op Fl f Ar type Ns Cm \&: Ns Ar format
57 .Op Fl f Ar type Ns Cm \&: Ns Ar format
72 .Op Fl f Ar type Ns Cm \&: Ns Ar format
76 utility is used to assign an address
77 to a network interface and/or configure
78 network interface parameters.
81 utility must be used at boot time to define the network address
82 of each interface present on a machine; it may also be used at
83 a later time to redefine an interface's address
84 or other operating parameters.
86 The following options are available:
87 .Bl -tag -width indent
89 Display information about all interfaces in the system.
93 flag may be used instead of the
97 List all the interface cloners available on the system,
98 with no additional information.
99 Use of this flag is mutually exclusive with all other flags and commands.
101 Display only the interfaces that are down.
103 .Ar type Ns Cm \&: Ns Ar format Ns
104 .Op Cm \&, Ns Ar type Ns Cm \&: Ns Ar format Ar ...
106 Control the output format of
108 The format is specified as a comma-separated list of
109 .Ar type Ns Cm \&: Ns Ar format
113 section for more information
116 The output format can also be specified via the
118 environment variable.
121 flag can be supplied multiple times.
129 .Bl -tag -width ether
131 Adjust the display of inet and inet6 addresses:
133 .Bl -tag -width default -compact
138 Fully qualified domain names
141 Unqualified hostnames
146 Adjust the display of link-level ethernet (MAC) addresses:
148 .Bl -tag -width default -compact
150 Separate address segments with a colon
152 Separate address segments with a dash
158 Adjust the display of inet address subnet masks:
160 .Bl -tag -width default -compact
162 CIDR notation, for example:
168 Dotted quad notation, for example:
171 Hexadecimal format, for example:
175 Adjust the display of inet6 address prefixes (subnet masks):
177 .Bl -tag -width default -compact
179 CIDR notation, for example:
187 Integer format, for example:
191 .It Fl G Ar groupname
192 Exclude members of the specified
199 should be specified as later override previous ones
201 may contain shell patterns in which case it should be quoted.
207 selects all interfaces.
208 .It Fl g Ar groupname
209 Limit the output to the members of the specified
214 is specified before other significant flags like, e.g.,
221 lists names of interfaces belonging to
223 Any other flags and arguments are ignored in this case.
227 should be specified as later override previous ones
229 may contain shell patterns in which case it should be quoted.
235 selects all interfaces.
237 Print keying information for the
241 For example, the values of 802.11 WEP keys and
243 passphrases will be printed, if accessible to the current user.
245 This information is not printed by default, as it may be considered
248 Display address lifetime for IPv6 addresses as time offset string.
250 List all available interfaces on the system,
251 with no other additional information.
255 is specified, only interfaces of that type will be listed.
263 will exclude loopback interfaces from the list of Ethernet interfaces.
264 This is a special case, because all the other synonyms of the
266 address family will include loopback interfaces in the list.
268 Use of this flag is mutually exclusive
269 with all other flags and commands, except for
275 Display the capability list and all
276 of the supported media for the specified interface.
278 Disable automatic loading of network interface drivers.
280 By default if the network interface driver is not present in the kernel
283 will attempt to load it.
285 Display only the interfaces that are up.
287 Get more verbose status for an interface.
290 the address is either a host name present in the host name data
293 or an IPv4 address expressed in the Internet standard
296 It is also possible to use the CIDR notation (also known as the
297 slash notation) to include the netmask.
298 That is, one can specify an address like
303 family, it is also possible to specify the prefix length using the slash
308 parameter below for more information.
313 is specified as a series of colon-separated hex digits.
314 This can be used to, for example,
315 set a new MAC address on an Ethernet interface, though the
316 mechanism used is not Ethernet specific.
320 keyword to set a randomly generated MAC address.
321 A randomly-generated MAC address might be the same as one already in use
323 Such duplications are extremely unlikely.
325 If the interface is already
326 up when the link-level address is modified,
327 it will be briefly brought down and
328 then brought back up again in order to ensure that the receive
329 filter in the underlying Ethernet hardware is properly reprogrammed.
330 .It Ar address_family
333 which affects interpretation of the remaining parameters.
334 Since an interface can receive transmissions in differing protocols
335 with different naming schemes, specifying the address family is recommended.
336 The address or protocol families currently
342 .Po with some exceptions, see
346 Default, if available.
357 Specify the address of the correspondent on the other end
358 of a point to point link.
361 parameter is a string of the form
369 utility displays the current configuration for a network interface
370 when no optional parameters are supplied.
371 If a protocol family is specified,
373 will report only the details specific to that protocol family.
375 When no arguments are given,
379 Only the super-user may modify the configuration of a network interface.
385 .Bl -tag -width indent
390 Introduced for compatibility
394 Establish an additional network address for this interface.
395 This is sometimes useful when changing network numbers, and
396 one wishes to accept packets addressed to the old interface.
397 If the address is on the same subnet as the first network address
398 for this interface, a non-conflicting netmask must be given.
403 Remove the network address specified.
404 This would be used if you incorrectly specified an alias, or it
405 was no longer needed.
406 If you have incorrectly set an NS address having the side effect
407 of specifying the host portion, removing all NS addresses will
408 allow you to respecify the host portion.
411 Specify that the address configured is an anycast address.
412 Based on the current specification,
413 only routers may configure anycast addresses.
414 Anycast address will not be used as source address of any of outgoing
417 Enable the use of the Address Resolution Protocol
420 between network level addresses and link level addresses (default).
421 This is currently implemented for mapping between Internet Protocol addresses
422 and IEEE 802 48-bit MAC addresses (Ethernet addresses).
424 Disable the use of the Address Resolution Protocol
427 If the Address Resolution Protocol is enabled,
428 the host will only reply to requests for its addresses,
429 and will never send any requests.
431 If the Address Resolution Protocol is enabled,
432 the host will perform normally,
433 sending out requests and listening for replies.
435 Enable the so-called sticky ARP mode for the interface.
436 If this option is enabled on the given interface, any resolved address is
437 marked as a static one and never expires. This may be used to increase
438 security of the network by preventing ARP spoofing or to reduce latency for
439 high-performance Ethernet networks where the time needed for ARP resolution is
440 too high. Please note that a similar feature is also provided for bridges. See
441 the sticky option in the
442 .Sx Bridge Interface Parameters
443 section. Enabling this
444 option may impact techniques which rely on ARP expiration/overwriting feature
445 such as load-balancers or high-availabity solutions such as
448 Disable the so-called sticky ARP mode for the interface (default).
449 Resolved addresses will expire normally respecting the kernel ARP
453 Specify the address to use to represent broadcasts to the
455 The default broadcast address is the address with a host part of all 1's.
457 Enable driver dependent debugging code; usually, this turns on
458 extra console error logging.
460 Disable driver dependent debugging code.
462 Put interface into permanently promiscuous mode.
464 Disable permanently promiscuous mode.
469 .It Cm description Ar value , Cm descr Ar value
470 Specify a description of the interface.
471 This can be used to label interfaces in situations where they may
472 otherwise be difficult to distinguish.
473 .It Cm -description , Cm -descr
474 Clear the interface description.
478 When an interface is marked
480 the system will not attempt to
481 transmit messages through that interface.
482 If possible, the interface will be reset to disable reception as well.
483 This action does not automatically disable routes using the interface.
484 .It Cm group Ar groupname
485 Assign the interface to a
487 Any interface can be in multiple groups.
489 Cloned interfaces are members of their interface family group by default.
490 For example, a VLAN interface such as
492 is a member of the VLAN interface family group,
494 .It Cm -group Ar groupname
495 Remove the interface from the given
500 (lowermost 64bit of an IPv6 address)
502 .It Cm fib Ar fib_number
503 Specify interface FIB.
506 is assigned to all frames or packets received on that interface.
507 The FIB is not inherited, e.g., vlans or other sub-interfaces will use
508 the default FIB (0) irrespective of the parent interface's FIB.
509 The kernel needs to be tuned to support more than the default FIB
512 kernel configuration option, or the
515 .It Cm tunnelfib Ar fib_number
519 is assigned to all packets encapsulated by tunnel interface, e.g.,
524 .It Cm maclabel Ar label
525 If Mandatory Access Control support is enabled in the kernel,
529 .\" .Xr maclabel 7 ) .
531 If the driver supports the media selection system, set the media type
534 Some interfaces support the mutually exclusive use of one of several
535 different physical media connectors.
536 For example, a 10Mbit/s Ethernet
537 interface might support the use of either AUI
538 or twisted pair connectors.
539 Setting the media type to
541 would change the currently active connector to the AUI port.
544 would activate twisted pair.
545 Refer to the interfaces' driver
546 specific documentation or man page for a complete list of the
548 .It Cm mediaopt Ar opts
549 If the driver supports the media selection system, set the specified
550 media options on the interface.
554 is a comma delimited list of options to apply to the interface.
555 Refer to the interfaces' driver specific man page for a complete
556 list of available options.
557 .It Fl mediaopt Ar opts
558 If the driver supports the media selection system, disable the
559 specified media options on the interface.
561 If the driver supports the media selection system, set the specified
562 operating mode on the interface to
564 For IEEE 802.11 wireless interfaces that support multiple operating modes
565 this directive is used to select between 802.11a
573 Set if the driver supports TX rate limiting.
574 .It Cm inst Ar minst , Cm instance Ar minst
575 Set the media instance to
577 This is useful for devices which have multiple physical layer interfaces
580 Set the interface name to
582 .It Cm rxcsum , txcsum , rxcsum6 , txcsum6
583 If the driver supports user-configurable checksum offloading,
584 enable receive (or transmit) checksum offloading on the interface.
585 The feature can be turned on selectively per protocol family.
587 .Cm rxcsum6 , txcsum6
593 Some drivers may not be able to enable these flags independently
594 of each other, so setting one may also set the other.
595 The driver will offload as much checksum work as it can reliably
596 support, the exact level of offloading varies between drivers.
597 .It Fl rxcsum , txcsum , rxcsum6 , txcsum6
598 If the driver supports user-configurable checksum offloading,
599 disable receive (or transmit) checksum offloading on the interface.
600 The feature can be turned off selectively per protocol family.
602 .Fl rxcsum6 , txcsum6
608 These settings may not always be independent of each other.
610 If the driver supports
612 segmentation offloading, enable TSO on the interface.
613 Some drivers may not be able to support TSO for
617 packets, so they may enable only one of them.
619 If the driver supports
621 segmentation offloading, disable TSO on the interface.
622 It will always disable TSO for
627 If the driver supports
629 segmentation offloading for
633 use one of these to selectively enabled it only for one protocol family.
635 If the driver supports
637 segmentation offloading for
641 use one of these to selectively disable it only for one protocol family.
643 If the driver supports
645 large receive offloading, enable LRO on the interface.
647 If the driver supports
649 large receive offloading, disable LRO on the interface.
651 Transmit TLS offload encrypts Transport Layer Security (TLS) records and
652 segments the encrypted record into one or more
658 If the driver supports transmit TLS offload,
659 enable transmit TLS offload on the interface.
660 Some drivers may not be able to support transmit TLS offload for
664 packets, so they may enable only one of them.
666 If the driver supports transmit TLS offload,
667 disable transmit TLS offload on the interface.
668 It will always disable TLS for
673 Enable use of rate limiting (packet pacing) for TLS offload.
675 Disable use of rate limiting for TLS offload.
677 If the driver supports extended multi-page
679 buffers, enable them on the interface.
681 If the driver supports extended multi-page
683 biffers, disable them on the interface.
684 .It Cm wol , wol_ucast , wol_mcast , wol_magic
685 Enable Wake On Lan (WOL) support, if available.
686 WOL is a facility whereby a machine in a low power state may be woken
687 in response to a received packet.
688 There are three types of packets that may wake a system:
689 ucast (directed solely to the machine's mac address),
690 mcast (directed to a broadcast or multicast address),
693 .Po unicast or multicast frames with a
696 Not all devices support WOL, those that do indicate the mechanisms
697 they support in their capabilities.
699 is a synonym for enabling all available WOL mechanisms.
702 .It Cm vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
703 If the driver offers user-configurable VLAN support, enable
704 reception of extended frames, tag processing in hardware,
705 frame filtering in hardware, checksum offloading, or TSO on VLAN,
707 Note that this must be configured on a physical interface associated with
712 .It Fl vlanmtu , vlanhwtag , vlanhwfilter , vlanhwcsum , vlanhwtso
713 If the driver offers user-configurable VLAN support, disable
714 reception of extended frames, tag processing in hardware,
715 frame filtering in hardware, checksum offloading, or TSO on VLAN,
717 .It Cm vxlanhwcsum , vxlanhwtso
718 If the driver offers user-configurable VXLAN support, enable inner checksum
719 offloading (receive and transmit) or TSO on VXLAN, respectively.
720 Note that this must be configured on a physical interface associated with
725 The physical interface is either the interface specified as the vxlandev
726 or the interface hosting the vxlanlocal address.
727 The driver will offload as much checksum work and TSO as it can reliably
728 support, the exact level of offloading may vary between drivers.
729 .It Fl vxlanhwcsum , vxlanhwtso
730 If the driver offers user-configurable VXLAN support, disable checksum
731 offloading (receive and transmit) or TSO on VXLAN, respectively.
733 Move the interface to the
735 specified by name or JID.
736 If the jail has a virtual network stack, the interface will disappear
737 from the current environment and become visible to the jail.
739 Reclaim the interface from the
741 specified by name or JID.
742 If the jail has a virtual network stack, the interface will disappear
743 from the jail, and become visible to the current network environment.
747 feature and disable interrupts on the interface, if driver supports
752 feature and enable interrupt mode on the interface.
754 Create the specified network pseudo-device.
755 If the interface is given without a unit number, try to create a new
756 device with an arbitrary unit number.
757 If creation of an arbitrary device is successful, the new device name is
758 printed to standard output unless the interface is renamed or destroyed
763 Destroy the specified network pseudo-device.
768 Included for Solaris compatibility.
773 Included for Solaris compatibility.
775 Set the routing metric of the interface to
778 The routing metric is used by the routing protocol
780 Higher metrics have the effect of making a route
781 less favorable; metrics are counted as additional hops
782 to the destination network or host.
784 Set the maximum transmission unit of the interface to
786 default is interface specific.
787 The MTU is used to limit the size of packets that are transmitted on an
789 Not all interfaces support setting the MTU, and some interfaces have
791 .It Cm netmask Ar mask
794 Specify how much of the address to reserve for subdividing
795 networks into sub-networks.
796 The mask includes the network part of the local address
797 and the subnet part, which is taken from the host field of the address.
798 The mask can be specified as a single hexadecimal number
801 with a dot-notation Internet address,
802 or with a pseudo-network name listed in the network table
804 The mask contains 1's for the bit positions in the 32-bit address
805 which are to be used for the network and subnet parts,
806 and 0's for the host part.
807 The mask should contain at least the standard network portion,
808 and the subnet field should be contiguous with the network
811 The netmask can also be specified in CIDR notation after the address.
814 option above for more information.
815 .It Cm prefixlen Ar len
819 bits are reserved for subdividing networks into sub-networks.
822 must be integer, and for syntactical reason it must be between 0 to 128.
823 It is almost always 64 under the current IPv6 assignment rule.
824 If the parameter is omitted, 64 is used.
826 The prefix can also be specified using the slash notation after the address.
829 option above for more information.
834 Introduced for compatibility
838 .It Cm link Op Cm 0 No - Cm 2
840 Enable special processing of the link level of the interface.
841 These three options are interface specific in actual effect, however,
842 they are in general used to select special modes of operation.
844 of this is to enable SLIP compression, or to select the connector type
845 for some Ethernet cards.
846 Refer to the man page for the specific driver
847 for more information.
849 .It Fl link Op Cm 0 No - Cm 2
851 Disable special processing at the link level with the specified interface.
853 Put the interface in monitor mode.
854 No packets are transmitted, and received packets are discarded after
858 Take the interface out of monitor mode.
859 .It Cm pcp Ar priority_code_point
862 is an 3-bit field which refers to the IEEE 802.1p
863 class of service and maps to the frame priority level.
865 Stop tagging packets on the interface w/ the priority code point.
869 This may be used to enable an interface after an
871 It happens automatically when setting the first address on an interface.
872 If the interface was reset when previously marked down,
873 the hardware will be re-initialized.
875 .Ss ICMPv6 Neighbor Discovery Protocol Parameters
876 The following parameters are for ICMPv6 Neighbor Discovery Protocol.
877 Note that the address family keyword
880 .Bl -tag -width indent
882 Set a flag to enable accepting ICMPv6 Router Advertisement messages.
886 .Va net.inet6.ip6.accept_rtadv
887 controls whether this flag is set by default or not.
892 Set a flag to control whether routers from which the system accepts
893 Router Advertisement messages will be added to the Default Router List
897 flag is disabled, this flag has no effect.
901 .Va net.inet6.ip6.no_radr
902 controls whether this flag is set by default or not.
906 .It Cm auto_linklocal
907 Set a flag to perform automatic link-local address configuration when
908 the interface becomes available.
912 .Va net.inet6.ip6.auto_linklocal
913 controls whether this flag is set by default or not.
914 .It Cm -auto_linklocal
918 Set the specified interface as the default route when there is no
924 Set a flag to disable all of IPv6 network communications on the
926 Note that if there are already configured IPv6
927 addresses on that interface, all of them are marked as
929 and DAD will be performed when this flag is cleared.
933 When this flag is cleared and
935 flag is enabled, automatic configuration of a link-local address is
938 Set a flag to enable Neighbor Unreachability Detection.
942 .It Cm no_prefer_iface
943 Set a flag to not honor rule 5 of source address selection in RFC 3484.
944 In practice this means the address on the outgoing interface will not be
945 preferred, effectively yielding the decision to the address selection
946 policy table, configurable with
948 .It Cm -no_prefer_iface
950 .Cm no_prefer_iface .
952 Set a flag to disable Duplicate Address Detection.
958 The following parameters are specific for IPv6 addresses.
959 Note that the address family keyword
962 .Bl -tag -width indent
964 Set the IPv6 autoconfigured address bit.
966 Clear the IPv6 autoconfigured address bit.
968 Set the IPv6 deprecated address bit.
970 Clear the IPv6 deprecated address bit.
972 Set preferred lifetime for the address.
974 Set a flag to prefer address as a candidate of the source address for
976 .It Cm -prefer_source
980 Set valid lifetime for the address.
982 .Ss IEEE 802.11 Wireless Interfaces Cloning Parameters
983 The following parameters are specific to cloning
984 IEEE 802.11 wireless interfaces with the
987 .Bl -tag -width indent
988 .It Cm wlandev Ar device
991 as the parent for the cloned device.
992 .It Cm wlanmode Ar mode
993 Specify the operating mode for this cloned device.
1011 The operating mode of a cloned interface cannot be changed.
1014 mode is actually implemented as an
1016 interface with special properties.
1017 .It Cm wlanbssid Ar bssid
1018 The 802.11 mac address to use for the bssid.
1019 This must be specified at create time for a legacy
1022 .It Cm wlanaddr Ar address
1023 The local mac address.
1024 If this is not specified then a mac address will automatically be assigned
1025 to the cloned device.
1026 Typically this address is the same as the address of the parent device
1029 parameter is specified then the driver will craft a unique address for
1030 the device (if supported).
1034 device as operating in
1038 devices have a fixed peer relationship and do not, for example, roam
1039 if their peer stops communicating.
1040 For completeness a Dynamic WDS (DWDS) interface may marked as
1043 Request a unique local mac address for the cloned device.
1044 This is only possible if the device supports multiple mac addresses.
1045 To force use of the parent's mac address use
1048 Mark the cloned interface as depending on hardware support to
1049 track received beacons.
1050 To have beacons tracked in software use
1056 can also be used to indicate no beacons should
1057 be transmitted; this can be useful when creating a WDS configuration but
1059 interfaces can only be created as companions to an access point.
1061 .Ss Cloned IEEE 802.11 Wireless Interface Parameters
1062 The following parameters are specific to IEEE 802.11 wireless interfaces
1066 .Bl -tag -width indent
1068 Enable sending and receiving AMPDU frames when using 802.11n (default).
1069 The 802.11n specification states a compliant station must be capable
1070 of receiving AMPDU frames but transmission is optional.
1073 to disable all use of AMPDU with 802.11n.
1074 For testing and/or to work around interoperability problems one can use
1078 to control use of AMPDU in one direction.
1079 .It Cm ampdudensity Ar density
1080 Set the AMPDU density parameter used when operating with 802.11n.
1081 This parameter controls the inter-packet gap for AMPDU frames.
1082 The sending device normally controls this setting but a receiving station
1083 may request wider gaps.
1086 are 0, .25, .5, 1, 2, 4, 8, and 16 (microseconds).
1089 is treated the same as 0.
1090 .It Cm ampdulimit Ar limit
1091 Set the limit on packet size for receiving AMPDU frames when operating
1095 are 8192, 16384, 32768, and 65536 but one can also specify
1096 just the unique prefix: 8, 16, 32, 64.
1097 Note the sender may limit the size of AMPDU frames to be less
1098 than the maximum specified by the receiving station.
1100 Enable sending and receiving AMSDU frames when using 802.11n.
1101 By default AMSDU is received but not transmitted.
1104 to disable all use of AMSDU with 802.11n.
1105 For testing and/or to work around interoperability problems one can use
1109 to control use of AMSDU in one direction.
1110 .It Cm amsdulimit Ar limit
1111 Set the limit on packet size for sending and receiving AMSDU frames
1112 when operating with 802.11n.
1115 are 7935 and 3839 (bytes).
1116 Note the sender may limit the size of AMSDU frames to be less
1117 than the maximum specified by the receiving station.
1118 Note also that devices are not required to support the 7935 limit,
1119 only 3839 is required by the specification and the larger value
1120 may require more memory to be dedicated to support functionality
1121 that is rarely used.
1123 When operating as an access point, pass packets between
1124 wireless clients directly (default).
1125 To instead let them pass up through the
1126 system and be forwarded using some other mechanism, use
1128 Disabling the internal bridging
1129 is useful when traffic is to be processed with
1131 .It Cm authmode Ar mode
1132 Set the desired authentication mode in infrastructure mode.
1133 Not all adapters support all modes.
1136 .Cm none , open , shared
1142 (IEEE WPA/WPA2/802.11i).
1147 modes are only useful when using an authentication service
1148 (a supplicant for client operation or an authenticator when
1149 operating as an access point).
1150 Modes are case insensitive.
1152 Enable background scanning when operating as a station.
1153 Background scanning is a technique whereby a station associated to
1154 an access point will temporarily leave the channel to scan for
1155 neighboring stations.
1156 This allows a station to maintain a cache of nearby access points
1157 so that roaming between access points can be done without
1158 a lengthy scan operation.
1159 Background scanning is done only when a station is not busy and
1160 any outbound traffic will cancel a scan operation.
1161 Background scanning should never cause packets to be lost though
1162 there may be some small latency if outbound traffic interrupts a
1164 By default background scanning is enabled if the device is capable.
1165 To disable background scanning, use
1167 Background scanning is controlled by the
1172 Background scanning must be enabled for roaming; this is an artifact
1173 of the current implementation and may not be required in the future.
1174 .It Cm bgscanidle Ar idletime
1175 Set the minimum time a station must be idle (not transmitting or
1176 receiving frames) before a background scan is initiated.
1179 parameter is specified in milliseconds.
1180 By default a station must be idle at least 250 milliseconds before
1181 a background scan is initiated.
1182 The idle time may not be set to less than 100 milliseconds.
1183 .It Cm bgscanintvl Ar interval
1184 Set the interval at which background scanning is attempted.
1187 parameter is specified in seconds.
1188 By default a background scan is considered every 300 seconds (5 minutes).
1191 may not be set to less than 15 seconds.
1192 .It Cm bintval Ar interval
1193 Set the interval at which beacon frames are sent when operating in
1197 parameter is specified in TU's (1024 usecs).
1198 By default beacon frames are transmitted every 100 TU's.
1199 .It Cm bmissthreshold Ar count
1200 Set the number of consecutive missed beacons at which the station
1201 will attempt to roam (i.e., search for a new access point).
1204 parameter must be in the range 1 to 255; though the
1205 upper bound may be reduced according to device capabilities.
1206 The default threshold is 7 consecutive missed beacons; but
1207 this may be overridden by the device driver.
1208 Another name for the
1212 .It Cm bssid Ar address
1213 Specify the MAC address of the access point to use when operating
1214 as a station in a BSS network.
1215 This overrides any automatic selection done by the system.
1216 To disable a previously selected access point, supply
1221 This option is useful when more than one access point uses the same SSID.
1222 Another name for the
1227 Enable packet bursting.
1228 Packet bursting is a transmission technique whereby the wireless
1229 medium is acquired once to send multiple frames and the interframe
1231 This technique can significantly increase throughput by reducing
1232 transmission overhead.
1233 Packet bursting is supported by the 802.11e QoS specification
1234 and some devices that do not support QoS may still be capable.
1235 By default packet bursting is enabled if a device is capable
1237 To disable packet bursting, use
1239 .It Cm chanlist Ar channels
1240 Set the desired channels to use when scanning for access
1241 points, neighbors in an IBSS network, or looking for unoccupied
1242 channels when operating as an access point.
1243 The set of channels is specified as a comma-separated list with
1244 each element in the list representing either a single channel number or a range
1247 Channel numbers must be in the range 1 to 255 and be permissible
1248 according to the operating characteristics of the device.
1249 .It Cm channel Ar number
1250 Set a single desired channel.
1251 Channels range from 1 to 255, but the exact selection available
1252 depends on the region your adaptor was manufactured for.
1258 will clear any desired channel and, if the device is marked up,
1259 force a scan for a channel to operate on.
1260 Alternatively the frequency, in megahertz, may be specified
1261 instead of the channel number.
1263 When there are several ways to use a channel the channel
1264 number/frequency may be appended with attributes to clarify.
1265 For example, if a device is capable of operating on channel 6
1266 with 802.11n and 802.11g then one can specify that g-only use
1267 should be used by specifying
1269 Similarly the channel width can be specified by appending it
1274 specifies a 40MHz wide channel.
1275 These attributes can be combined as in:
1278 The full set of flags specified following a
1288 Atheros Dynamic Turbo mode
1297 Atheros Static Turbo mode
1299 Atheros Dynamic Turbo mode, or appended to
1305 The full set of channel widths following a
1311 5MHz aka quarter-rate channel
1313 10MHz aka half-rate channel
1315 20MHz mostly for use in specifying
1318 40MHz mostly for use in specifying
1323 a 40MHz HT channel specification may include the location
1324 of the extension channel by appending
1328 for above and below,
1331 specifies 40MHz wide HT operation
1332 with the center channel at frequency 2437 and the extension channel above.
1333 .It Cm country Ar name
1334 Set the country code to use in calculating the regulatory constraints
1336 In particular the set of available channels, how the wireless device
1337 will operation on the channels, and the maximum transmit power that
1338 can be used on a channel are defined by this setting.
1339 Country/Region codes are specified as a 2-character abbreviation
1340 defined by ISO 3166 or using a longer, but possibly ambiguous, spelling;
1341 e.g., "ES" and "Spain".
1342 The set of country codes are taken from
1343 .Pa /etc/regdomain.xml
1348 Note that not all devices support changing the country code from a default
1349 setting; typically stored in EEPROM.
1357 Enable Dynamic Frequency Selection (DFS) as specified in 802.11h.
1358 DFS embodies several facilities including detection of overlapping
1359 radar signals, dynamic transmit power control, and channel selection
1360 according to a least-congested criteria.
1361 DFS support is mandatory for some 5GHz frequencies in certain
1362 locales (e.g., ETSI).
1363 By default DFS is enabled according to the regulatory definitions
1365 .Pa /etc/regdomain.xml
1366 and the current country code, regdomain,
1368 Note the underlying device (and driver) must support radar detection
1369 for full DFS support to work.
1370 To be fully compliant with the local regulatory agency frequencies that
1371 require DFS should not be used unless it is fully supported.
1374 to disable this functionality for testing.
1376 Enable support for the 802.11d specification (default).
1377 When this support is enabled in station mode, beacon frames that advertise
1378 a country code different than the currently configured country code will
1379 cause an event to be dispatched to user applications.
1380 This event can be used by the station to adopt that country code and
1381 operate according to the associated regulatory constraints.
1382 When operating as an access point with 802.11d enabled the beacon and
1383 probe response frames transmitted will advertise the current regulatory
1385 To disable 802.11d use
1388 Enable 802.11h support including spectrum management.
1389 When 802.11h is enabled beacon and probe response frames will have
1390 the SpectrumMgt bit set in the capabilities field and
1391 country and power constraint information elements will be present.
1392 802.11h support also includes handling Channel Switch Announcements (CSA)
1393 which are a mechanism to coordinate channel changes by an access point.
1394 By default 802.11h is enabled if the device is capable.
1395 To disable 802.11h use
1397 .It Cm deftxkey Ar index
1398 Set the default key to use for transmission.
1399 Typically this is only set when using WEP encryption.
1400 Note that you must set a default transmit key
1401 for the system to know which key to use in encrypting outbound traffic.
1404 is an alias for this request; it is provided for backwards compatibility.
1405 .It Cm dtimperiod Ar period
1408 period for transmitting buffered multicast data frames when
1409 operating in ap mode.
1412 specifies the number of beacon intervals between DTIM
1413 and must be in the range 1 to 15.
1414 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
1416 Enable the use of quiet IE.
1417 Hostap will use this to silence other
1418 stations to reduce interference for radar detection when
1419 operating on 5GHz frequency and doth support is enabled.
1422 to disable this functionality.
1423 .It Cm quiet_period Ar period
1426 to the number of beacon intervals between the start of regularly
1427 scheduled quiet intervals defined by Quiet element.
1428 .It Cm quiet_count Ar count
1431 to the number of TBTTs until the beacon interval during which the
1432 next quiet interval shall start.
1433 A value of 1 indicates the quiet
1434 interval will start during the beacon interval starting at the next
1436 A value 0 is reserved.
1437 .It Cm quiet_offset Ar offset
1440 to the offset of the start of the quiet interval from the TBTT
1441 specified by the Quiet count, expressed in TUs.
1444 shall be less than one beacon interval.
1445 .It Cm quiet_duration Ar dur
1448 to the duration of the Quiet interval, expressed in TUs.
1449 The value should be less than beacon interval.
1451 Enable the use of Atheros Dynamic Turbo mode when communicating with
1452 another Dynamic Turbo-capable station.
1453 Dynamic Turbo mode is an Atheros-specific mechanism by which
1454 stations switch between normal 802.11 operation and a
1456 mode in which a 40MHz wide channel is used for communication.
1457 Stations using Dynamic Turbo mode operate boosted only when the
1458 channel is free of non-dturbo stations; when a non-dturbo station
1459 is identified on the channel all stations will automatically drop
1460 back to normal operation.
1461 By default, Dynamic Turbo mode is not enabled, even if the device is capable.
1462 Note that turbo mode (dynamic or static) is only allowed on some
1463 channels depending on the regulatory constraints; use the
1465 command to identify the channels where turbo mode may be used.
1466 To disable Dynamic Turbo mode use
1469 Enable Dynamic WDS (DWDS) support.
1470 DWDS is a facility by which 4-address traffic can be carried between
1471 stations operating in infrastructure mode.
1472 A station first associates to an access point and authenticates using
1473 normal procedures (e.g., WPA).
1474 Then 4-address frames are passed to carry traffic for stations
1475 operating on either side of the wireless link.
1476 DWDS extends the normal WDS mechanism by leveraging existing security
1477 protocols and eliminating static binding.
1479 When DWDS is enabled on an access point 4-address frames received from
1480 an authorized station will generate a
1484 This event should be used to create a WDS interface that is bound
1485 to the remote station (and usually plumbed into a bridge).
1486 Once the WDS interface is up and running 4-address traffic then logically
1487 flows through that interface.
1489 When DWDS is enabled on a station, traffic with a destination address
1490 different from the peer station are encapsulated in a 4-address frame
1491 and transmitted to the peer.
1492 All 4-address traffic uses the security information of the stations
1493 (e.g., cryptographic keys).
1494 A station is associated using 802.11n facilities may transport
1495 4-address traffic using these same mechanisms; this depends on available
1496 resources and capabilities of the device.
1497 The DWDS implementation guards against layer 2 routing loops of
1500 Enable the use of Atheros Fast Frames when communicating with
1501 another Fast Frames-capable station.
1502 Fast Frames are an encapsulation technique by which two 802.3
1503 frames are transmitted in a single 802.11 frame.
1504 This can noticeably improve throughput but requires that the
1505 receiving station understand how to decapsulate the frame.
1506 Fast frame use is negotiated using the Atheros 802.11 vendor-specific
1507 protocol extension so enabling use is safe when communicating with
1508 non-Atheros devices.
1509 By default, use of fast frames is enabled if the device is capable.
1510 To explicitly disable fast frames, use
1512 .It Cm fragthreshold Ar length
1513 Set the threshold for which transmitted frames are broken into fragments.
1516 argument is the frame size in bytes and must be in the range 256 to 2346.
1524 disables transmit fragmentation.
1525 Not all adapters honor the fragmentation threshold.
1527 When operating as an access point, do not broadcast the SSID
1528 in beacon frames or respond to probe request frames unless
1529 they are directed to the ap (i.e., they include the ap's SSID).
1530 By default, the SSID is included in beacon frames and
1531 undirected probe request frames are answered.
1532 To re-enable the broadcast of the SSID etc., use
1535 Enable use of High Throughput (HT) when using 802.11n (default).
1536 The 802.11n specification includes mechanisms for operation
1537 on 20MHz and 40MHz wide channels using different signalling mechanisms
1538 than specified in 802.11b, 802.11g, and 802.11a.
1539 Stations negotiate use of these facilities, termed HT20 and HT40,
1540 when they associate.
1541 To disable all use of 802.11n use
1543 To disable use of HT20 (e.g., to force only HT40 use) use
1545 To disable use of HT40 use
1548 HT configuration is used to
1551 when several choices are available.
1552 For example, if a station associates to an 11n-capable access point
1553 it controls whether the station uses legacy operation, HT20, or HT40.
1554 When an 11n-capable device is setup as an access point and
1555 Auto Channel Selection is used to locate a channel to operate on,
1556 HT configuration controls whether legacy, HT20, or HT40 operation is setup
1557 on the selected channel.
1558 If a fixed channel is specified for a station then HT configuration can
1559 be given as part of the channel specification; e.g., 6:ht/20 to setup
1560 HT20 operation on channel 6.
1562 Enable use of compatibility support for pre-802.11n devices (default).
1563 The 802.11n protocol specification went through several incompatible iterations.
1564 Some vendors implemented 11n support to older specifications that
1565 will not interoperate with a purely 11n-compliant station.
1566 In particular the information elements included in management frames
1567 for old devices are different.
1568 When compatibility support is enabled both standard and compatible data
1570 Stations that associate using the compatibility mechanisms are flagged
1573 To disable compatibility support use
1575 .It Cm htprotmode Ar technique
1576 For interfaces operating in 802.11n, use the specified
1578 for protecting HT frames in a mixed legacy/HT network.
1579 The set of valid techniques is
1584 Technique names are case insensitive.
1586 Enable inactivity processing for stations associated to an
1587 access point (default).
1588 When operating as an access point the 802.11 layer monitors
1589 the activity of each associated station.
1590 When a station is inactive for 5 minutes it will send several
1592 to see if the station is still present.
1593 If no response is received then the station is deauthenticated.
1594 Applications that prefer to handle this work can disable this
1598 Set the location to use in calculating regulatory constraints.
1599 The location is also advertised in beacon and probe response frames
1600 when 802.11d is enabled with
1609 Display the list of channels available for use taking into account
1610 any restrictions set with the
1613 See the description of
1615 for more information.
1617 Display the adaptor's capabilities, including the operating
1620 Display the list of channels available for use.
1621 Channels are shown with their IEEE channel number, equivalent
1622 frequency, and usage modes.
1623 Channels identified as
1628 Channels identified as
1630 may be used only for Atheros' Static Turbo mode
1632 . Cm mediaopt turbo ) .
1633 Channels marked with a
1635 have a regulatory constraint that they be passively scanned.
1636 This means a station is not permitted to transmit on the channel until
1637 it identifies the channel is being used for 802.11 communication;
1638 typically by hearing a beacon frame from an access point operating
1641 is another way of requesting this information.
1642 By default a compacted list of channels is displayed; if the
1644 option is specified then all channels are shown.
1645 .It Cm list countries
1646 Display the set of country codes and regulatory domains that can be
1647 used in regulatory configuration.
1649 Display the current MAC Access Control List state.
1650 Each address is prefixed with a character that indicates the
1651 current policy applied to it:
1653 indicates the address is allowed access,
1655 indicates the address is denied access,
1657 indicates the address is present but the current policy open
1658 (so the ACL is not consulted).
1660 Displays the mesh routing table, used for forwarding packets on a mesh
1662 .It Cm list regdomain
1663 Display the current regulatory settings including the available channels
1664 and transmit power caps.
1666 Display the parameters that govern roaming operation.
1668 Display the parameters that govern transmit operation.
1670 Display the transmit power caps for each channel.
1672 Display the access points and/or ad-hoc neighbors
1673 located in the vicinity.
1674 This information may be updated automatically by the adapter
1677 request or through background scanning.
1678 Depending on the capabilities of the stations the following
1679 flags (capability codes) can be included in the output:
1686 Poll request capability.
1688 DSSS/OFDM capability.
1690 Extended Service Set (ESS).
1691 Indicates that the station is part of an infrastructure network
1692 rather than an IBSS/ad-hoc network.
1694 Independent Basic Service Set (IBSS).
1695 Indicates that the station is part of an ad-hoc network
1696 rather than an ESS network.
1699 The station requires authentication and encryption
1700 for all data frames exchanged within the BSS using cryptographic means
1701 such as WEP, TKIP, or AES-CCMP.
1703 Robust Secure Network (RSN).
1706 Indicates that the network is using short preambles,
1707 defined in 802.11b High Rate/DSSS PHY,
1708 and utilizes a 56 bit sync field
1709 rather than the 128 bit field used in long preamble mode.
1710 Short preambles are used to optionally
1711 improve throughput performance with 802.11g and 802.11b.
1713 Pollable capability.
1715 Short slot time capability.
1716 Indicates that the 802.11g network is using a short slot time
1717 because there are no legacy (802.11b) stations present.
1720 By default interesting information elements captured from the neighboring
1721 stations are displayed at the end of each row.
1722 Possible elements include:
1724 (station supports WME),
1726 (station supports WPA),
1728 (station supports WPS),
1730 (station supports 802.11i/RSN),
1732 (station supports 802.11n/HT communication),
1734 (station supports Atheros protocol extensions),
1736 (station supports unknown vendor-specific extensions).
1739 flag is used all the information elements and their
1740 contents will be shown.
1743 flag also enables display of long SSIDs.
1746 command is another way of requesting this information.
1748 When operating as an access point display the stations that are
1749 currently associated.
1750 When operating in ad-hoc mode display stations identified as
1751 neighbors in the IBSS.
1752 When operating in mesh mode display stations identified as
1753 neighbors in the MBSS.
1754 When operating in station mode display the access point.
1755 Capabilities advertised by the stations are described under
1759 The following flags can be included in the output:
1763 Indicates that the station is permitted to send/receive data frames.
1765 Extended Rate Phy (ERP).
1766 Indicates that the station is operating in an 802.11g network
1767 using extended transmit rates.
1769 High Throughput (HT).
1770 Indicates that the station is using HT transmit rates.
1773 follows immediately after then the station associated
1774 using deprecated mechanisms supported only when
1779 Indicates that the station is operating in power save mode.
1781 Quality of Service (QoS).
1782 Indicates that the station is using QoS encapsulation for
1784 QoS encapsulation is enabled only when WME mode is enabled.
1786 Short GI in HT 40MHz mode enabled.
1789 follows immediately after then short GI in HT 20MHz mode is enabled as well.
1791 Transitional Security Network (TSN).
1792 Indicates that the station associated using TSN; see also
1796 Wi-Fi Protected Setup (WPS).
1797 Indicates that the station associated using WPS.
1799 Short GI in HT 20MHz mode enabled.
1802 By default information elements received from associated stations
1803 are displayed in a short form; the
1805 flag causes this information to be displayed symbolically.
1807 Display the current channel parameters to use when operating in WME mode.
1810 option is specified then both channel and BSS parameters are displayed
1811 for each AC (first channel, then BSS).
1812 When WME mode is enabled for an adaptor this information will be
1813 displayed with the regular status; this command is mostly useful
1814 for examining parameters when WME mode is disabled.
1815 See the description of the
1817 directive for information on the various parameters.
1818 .It Cm maxretry Ar count
1819 Set the maximum number of tries to use in sending unicast frames.
1820 The default setting is 6 but drivers may override this with a value
1822 .It Cm mcastrate Ar rate
1823 Set the rate for transmitting multicast/broadcast frames.
1824 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1825 This rate should be valid for the current operating conditions;
1826 if an invalid rate is specified drivers are free to chose an
1828 .It Cm mgtrate Ar rate
1829 Set the rate for transmitting management and/or control frames.
1830 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
1832 Set the location to use in calculating regulatory constraints.
1833 The location is also advertised in beacon and probe response frames
1834 when 802.11d is enabled with
1843 Enable powersave operation.
1844 When operating as a client, the station will conserve power by
1845 periodically turning off the radio and listening for
1846 messages from the access point telling it there are packets waiting.
1847 The station must then retrieve the packets.
1848 Not all devices support power save operation as a client.
1849 The 802.11 specification requires that all access points support
1850 power save but some drivers do not.
1853 to disable powersave operation when operating as a client.
1854 .It Cm powersavesleep Ar sleep
1855 Set the desired max powersave sleep time in TU's (1024 usecs).
1856 By default the max powersave sleep time is 100 TU's.
1857 .It Cm protmode Ar technique
1858 For interfaces operating in 802.11g, use the specified
1860 for protecting OFDM frames in a mixed 11b/11g network.
1861 The set of valid techniques is
1867 Technique names are case insensitive.
1868 Not all devices support
1870 as a protection technique.
1872 When operating as an access point in 802.11g mode allow only
1873 11g-capable stations to associate (11b-only stations are not
1874 permitted to associate).
1875 To allow both 11g and 11b-only stations to associate, use
1878 When operating as an access point in 802.11n mode allow only
1879 HT-capable stations to associate (legacy stations are not
1880 permitted to associate).
1881 To allow both HT and legacy stations to associate, use
1883 .It Cm regdomain Ar sku
1884 Set the regulatory domain to use in calculating the regulatory constraints
1886 In particular the set of available channels, how the wireless device
1887 will operation on the channels, and the maximum transmit power that
1888 can be used on a channel are defined by this setting.
1889 Regdomain codes (SKU's) are taken from
1890 .Pa /etc/regdomain.xml
1895 Note that not all devices support changing the regdomain from a default
1896 setting; typically stored in EEPROM.
1904 Enable use of Reduced InterFrame Spacing (RIFS) when operating in 802.11n
1906 Note that RIFS must be supported by both the station and access point
1910 .It Cm roam:rate Ar rate
1911 Set the threshold for controlling roaming when operating in a BSS.
1914 parameter specifies the transmit rate in megabits
1915 at which roaming should be considered.
1916 If the current transmit rate drops below this setting and background scanning
1917 is enabled, then the system will check if a more desirable access point is
1918 available and switch over to it.
1919 The current scan cache contents are used if they are considered
1920 valid according to the
1922 parameter; otherwise a background scan operation is triggered before
1923 any selection occurs.
1924 Each channel type has a separate rate threshold; the default values are:
1925 12 Mb/s (11a), 2 Mb/s (11b), 2 Mb/s (11g), MCS 1 (11na, 11ng).
1926 .It Cm roam:rssi Ar rssi
1927 Set the threshold for controlling roaming when operating in a BSS.
1930 parameter specifies the receive signal strength in dBm units
1931 at which roaming should be considered.
1932 If the current rssi drops below this setting and background scanning
1933 is enabled, then the system will check if a more desirable access point is
1934 available and switch over to it.
1935 The current scan cache contents are used if they are considered
1936 valid according to the
1938 parameter; otherwise a background scan operation is triggered before
1939 any selection occurs.
1940 Each channel type has a separate rssi threshold; the default values are
1942 .It Cm roaming Ar mode
1943 When operating as a station, control how the system will
1944 behave when communication with the current access point
1948 argument may be one of
1950 (leave it to the hardware device to decide),
1952 (handle either in the device or the operating system\[em]as appropriate),
1954 (do nothing until explicitly instructed).
1955 By default, the device is left to handle this if it is
1956 capable; otherwise, the operating system will automatically
1957 attempt to reestablish communication.
1958 Manual mode is used by applications such as
1959 .Xr wpa_supplicant 8
1960 that want to control the selection of an access point.
1961 .It Cm rtsthreshold Ar length
1962 Set the threshold for which
1963 transmitted frames are preceded by transmission of an
1969 is the frame size in bytes and must be in the range 1 to 2346.
1977 disables transmission of RTS frames.
1978 Not all adapters support setting the RTS threshold.
1980 Initiate a scan of neighboring stations, wait for it to complete, and
1981 display all stations found.
1982 Only the super-user can initiate a scan.
1985 for information on the display.
1986 By default a background scan is done; otherwise a foreground
1987 scan is done and the station may roam to a different access point.
1990 request can be used to show recent scan results without
1991 initiating a new scan.
1992 .It Cm scanvalid Ar threshold
1993 Set the maximum time the scan cache contents are considered valid;
1994 i.e., will be used without first triggering a scan operation to
1998 parameter is specified in seconds and defaults to 60 seconds.
1999 The minimum setting for
2002 One should take care setting this threshold; if it is set too low
2003 then attempts to roam to another access point may trigger unnecessary
2004 background scan operations.
2006 Enable use of Short Guard Interval when operating in 802.11n
2008 NB: this currently enables Short GI on both HT40 and HT20 channels.
2009 To disable Short GI use
2012 Enable use of Static Spatial Multiplexing Power Save (SMPS)
2013 when operating in 802.11n.
2014 A station operating with Static SMPS maintains only a single
2015 receive chain active (this can significantly reduce power consumption).
2019 Enable use of Dynamic Spatial Multiplexing Power Save (SMPS)
2020 when operating in 802.11n.
2021 A station operating with Dynamic SMPS maintains only a single
2022 receive chain active but switches to multiple receive chains when it
2023 receives an RTS frame (this can significantly reduce power consumption).
2024 Note that stations cannot distinguish between RTS/CTS intended to
2025 enable multiple receive chains and those used for other purposes.
2029 Set the desired Service Set Identifier (aka network name).
2030 The SSID is a string up to 32 characters
2031 in length and may be specified as either a normal string or in
2032 hexadecimal when preceded by
2034 Additionally, the SSID may be cleared by setting it to
2036 .It Cm tdmaslot Ar slot
2037 When operating with TDMA, use the specified
2042 is a number between 0 and the maximum number of slots in the BSS.
2043 Note that a station configured as slot 0 is a master and
2044 will broadcast beacon frames advertising the BSS;
2045 stations configured to use other slots will always
2046 scan to locate a master before they ever transmit.
2050 .It Cm tdmaslotcnt Ar cnt
2051 When operating with TDMA, setup a BSS with
2054 The slot count may be at most 8.
2055 The current implementation is only tested with two stations
2056 (i.e., point to point applications).
2057 This setting is only meaningful when a station is configured as slot 0;
2058 other stations adopt this setting from the BSS they join.
2062 .It Cm tdmaslotlen Ar len
2063 When operating with TDMA, setup a BSS such that each station has a slot
2066 The slot length must be at least 150 microseconds (1/8 TU)
2067 and no more than 65 milliseconds.
2068 Note that setting too small a slot length may result in poor channel
2069 bandwidth utilization due to factors such as timer granularity and
2071 This setting is only meaningful when a station is configured as slot 0;
2072 other stations adopt this setting from the BSS they join.
2075 is set to 10 milliseconds.
2076 .It Cm tdmabintval Ar intval
2077 When operating with TDMA, setup a BSS such that beacons are transmitted every
2079 superframes to synchronize the TDMA slot timing.
2080 A superframe is defined as the number of slots times the slot length; e.g.,
2081 a BSS with two slots of 10 milliseconds has a 20 millisecond superframe.
2082 The beacon interval may not be zero.
2085 causes the timers to be resynchronized more often; this can be help if
2086 significant timer drift is observed.
2091 When operating as an access point with WPA/802.11i allow legacy
2092 stations to associate using static key WEP and open authentication.
2093 To disallow legacy station use of WEP, use
2095 .It Cm txpower Ar power
2096 Set the power used to transmit frames.
2099 argument is specified in .5 dBm units.
2100 Out of range values are truncated.
2101 Typically only a few discrete power settings are available and
2102 the driver will use the setting closest to the specified value.
2103 Not all adapters support changing the transmit power.
2104 .It Cm ucastrate Ar rate
2105 Set a fixed rate for transmitting unicast frames.
2106 Rates are specified as megabits/second in decimal; e.g.,\& 5.5 for 5.5 Mb/s.
2107 This rate should be valid for the current operating conditions;
2108 if an invalid rate is specified drivers are free to chose an
2110 .It Cm wepmode Ar mode
2111 Set the desired WEP mode.
2112 Not all adapters support all modes.
2113 The set of valid modes is
2119 mode explicitly tells the adaptor to allow association with access
2120 points which allow both encrypted and unencrypted traffic.
2123 means that the access point must only allow encrypted connections.
2126 is generally another name for
2128 Modes are case insensitive.
2129 .It Cm weptxkey Ar index
2130 Set the WEP key to be used for transmission.
2131 This is the same as setting the default transmission key with
2133 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
2134 Set the selected WEP key.
2137 is not given, key 1 is set.
2138 A WEP key will be either 5 or 13
2139 characters (40 or 104 bits) depending on the local network and the
2140 capabilities of the adaptor.
2141 It may be specified either as a plain
2142 string or as a string of hexadecimal digits preceded by
2144 For maximum portability, hex keys are recommended;
2145 the mapping of text keys to WEP encryption is usually driver-specific.
2146 In particular, the Windows drivers do this mapping differently to
2148 A key may be cleared by setting it to
2150 If WEP is supported then there are at least four keys.
2151 Some adapters support more than four keys.
2152 If that is the case, then the first four keys
2153 (1-4) will be the standard temporary keys and any others will be adaptor
2154 specific keys such as permanent keys stored in NVRAM.
2156 Note that you must set a default transmit key with
2158 for the system to know which key to use in encrypting outbound traffic.
2160 Enable Wireless Multimedia Extensions (WME) support, if available,
2161 for the specified interface.
2162 WME is a subset of the IEEE 802.11e standard to support the
2163 efficient communication of realtime and multimedia data.
2164 To disable WME support, use
2166 Another name for this parameter is
2169 The following parameters are meaningful only when WME support is in use.
2170 Parameters are specified per-AC (Access Category) and
2171 split into those that are used by a station when acting
2172 as an access point and those for client stations in the BSS.
2173 The latter are received from the access point and may not be changed
2175 The following Access Categories are recognized:
2177 .Bl -tag -width ".Cm AC_BK" -compact
2181 best effort delivery,
2196 AC parameters are case-insensitive.
2197 Traffic classification is done in the operating system using the
2198 vlan priority associated with data frames or the
2199 ToS (Type of Service) indication in IP-encapsulated frames.
2200 If neither information is present, traffic is assigned to the
2201 Best Effort (BE) category.
2202 .Bl -tag -width indent
2204 Set the ACK policy for QoS transmissions by the local station;
2205 this controls whether or not data frames transmitted by a station
2206 require an ACK response from the receiving station.
2207 To disable waiting for an ACK use
2209 This parameter is applied only to the local station.
2211 Enable the Admission Control Mandatory (ACM) mechanism
2212 for transmissions by the local station.
2213 To disable the ACM use
2215 On stations in a BSS this parameter is read-only and indicates
2216 the setting received from the access point.
2217 NB: ACM is not supported right now.
2218 .It Cm aifs Ar ac Ar count
2219 Set the Arbitration Inter Frame Spacing (AIFS)
2220 channel access parameter to use for transmissions
2221 by the local station.
2222 On stations in a BSS this parameter is read-only and indicates
2223 the setting received from the access point.
2224 .It Cm cwmin Ar ac Ar count
2225 Set the CWmin channel access parameter to use for transmissions
2226 by the local station.
2227 On stations in a BSS this parameter is read-only and indicates
2228 the setting received from the access point.
2229 .It Cm cwmax Ar ac Ar count
2230 Set the CWmax channel access parameter to use for transmissions
2231 by the local station.
2232 On stations in a BSS this parameter is read-only and indicates
2233 the setting received from the access point.
2234 .It Cm txoplimit Ar ac Ar limit
2235 Set the Transmission Opportunity Limit channel access parameter
2236 to use for transmissions by the local station.
2237 This parameter defines an interval of time when a WME station
2238 has the right to initiate transmissions onto the wireless medium.
2239 On stations in a BSS this parameter is read-only and indicates
2240 the setting received from the access point.
2241 .It Cm bss:aifs Ar ac Ar count
2242 Set the AIFS channel access parameter to send to stations in a BSS.
2243 This parameter is meaningful only when operating in ap mode.
2244 .It Cm bss:cwmin Ar ac Ar count
2245 Set the CWmin channel access parameter to send to stations in a BSS.
2246 This parameter is meaningful only when operating in ap mode.
2247 .It Cm bss:cwmax Ar ac Ar count
2248 Set the CWmax channel access parameter to send to stations in a BSS.
2249 This parameter is meaningful only when operating in ap mode.
2250 .It Cm bss:txoplimit Ar ac Ar limit
2251 Set the TxOpLimit channel access parameter to send to stations in a BSS.
2252 This parameter is meaningful only when operating in ap mode.
2255 Enable Wireless Privacy Subscriber support.
2256 Note that WPS support requires a WPS-capable supplicant.
2257 To disable this function use
2260 .Ss MAC-Based Access Control List Parameters
2261 The following parameters support an optional access control list
2262 feature available with some adapters when operating in ap mode; see
2264 This facility allows an access point to accept/deny association
2265 requests based on the MAC address of the station.
2266 Note that this feature does not significantly enhance security
2267 as MAC address spoofing is easy to do.
2268 .Bl -tag -width indent
2269 .It Cm mac:add Ar address
2270 Add the specified MAC address to the database.
2271 Depending on the policy setting association requests from the
2272 specified station will be allowed or denied.
2274 Set the ACL policy to permit association only by
2275 stations registered in the database.
2276 .It Cm mac:del Ar address
2277 Delete the specified MAC address from the database.
2279 Set the ACL policy to deny association only by
2280 stations registered in the database.
2281 .It Cm mac:kick Ar address
2282 Force the specified station to be deauthenticated.
2283 This typically is done to block a station after updating the
2286 Set the ACL policy to allow all stations to associate.
2288 Delete all entries in the database.
2290 Set the ACL policy to permit association only by
2291 stations approved by a RADIUS server.
2292 Note that this feature requires the
2294 program be configured to do the right thing
2295 as it handles the RADIUS processing
2296 (and marks stations as authorized).
2298 .Ss Mesh Mode Wireless Interface Parameters
2299 The following parameters are related to a wireless interface operating in mesh
2301 .Bl -tag -width indent
2302 .It Cm meshid Ar meshid
2303 Set the desired Mesh Identifier.
2304 The Mesh ID is a string up to 32 characters in length.
2305 A mesh interface must have a Mesh Identifier specified
2306 to reach an operational state.
2307 .It Cm meshttl Ar ttl
2310 for mesh forwarded packets;
2311 this is the number of hops a packet may be forwarded before
2313 The default setting for
2317 Enable or disable peering with neighbor mesh stations.
2318 Stations must peer before any data packets can be exchanged.
2323 Enable or disable forwarding packets by a mesh interface.
2328 This attribute specifies whether or not the mesh STA activates mesh gate
2333 .It Cm meshmetric Ar protocol
2336 as the link metric protocol used on a mesh network.
2337 The default protocol is called
2339 The mesh interface will restart after changing this setting.
2340 .It Cm meshpath Ar protocol
2343 as the path selection protocol used on a mesh network.
2344 The only available protocol at the moment is called
2346 (Hybrid Wireless Mesh Protocol).
2347 The mesh interface will restart after changing this setting.
2348 .It Cm hwmprootmode Ar mode
2349 Stations on a mesh network can operate as
2351 Root nodes try to find paths to all mesh nodes and advertise themselves
2353 When there is a root mesh node on a network, other mesh nodes can setup
2354 paths between themselves faster because they can use the root node
2355 to find the destination.
2356 This path may not be the best, but on-demand
2357 routing will eventually find the best path.
2358 The following modes are recognized:
2360 .Bl -tag -width ".Cm PROACTIVE" -compact
2364 Send broadcast path requests every two seconds.
2365 Nodes on the mesh without a path to this root mesh station with try to
2366 discover a path to us.
2368 Send broadcast path requests every two seconds and every node must reply
2369 with a path reply even if it already has a path to this root mesh station.
2371 Send broadcast root announcement (RANN) frames.
2372 Nodes on the mesh without a path to this root mesh station with try to
2373 discover a path to us.
2379 .It Cm hwmpmaxhops Ar cnt
2380 Set the maximum number of hops allowed in an HMWP path to
2382 The default setting for
2386 .Ss Compatibility Parameters
2387 The following parameters are for compatibility with other systems:
2388 .Bl -tag -width indent
2390 Another name for the
2396 .It Cm stationname Ar name
2397 Set the name of this station.
2398 The station name is not part of the IEEE 802.11
2399 protocol though some interfaces support it.
2401 seems to be meaningful to identical or virtually identical equipment.
2402 Setting the station name is identical in syntax to setting the SSID.
2409 Another way of saying
2415 Another way of saying
2421 Another way of saying:
2422 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
2428 .Ar n : k1 , k2 , k3 , k4
2431 Another way of saying
2432 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
2437 Another way of saying
2443 .Ss Bridge Interface Parameters
2444 The following parameters are specific to bridge interfaces:
2445 .Bl -tag -width indent
2446 .It Cm addm Ar interface
2447 Add the interface named by
2449 as a member of the bridge.
2450 The interface is put into promiscuous mode
2451 so that it can receive every packet sent on the network.
2452 .It Cm deletem Ar interface
2453 Remove the interface named by
2456 Promiscuous mode is disabled on the interface when
2457 it is removed from the bridge.
2458 .It Cm maxaddr Ar size
2459 Set the size of the bridge address cache to
2461 The default is 2000 entries.
2462 .It Cm timeout Ar seconds
2463 Set the timeout of address cache entries to
2468 is zero, then address cache entries will not be expired.
2469 The default is 1200 seconds.
2471 Display the addresses that have been learned by the bridge.
2472 .It Cm static Ar interface-name Ar address
2473 Add a static entry into the address cache pointing to
2474 .Ar interface-name .
2475 Static entries are never aged out of the cache or re-placed, even if the
2476 address is seen on a different interface.
2477 .It Cm deladdr Ar address
2480 from the address cache.
2482 Delete all dynamically-learned addresses from the address cache.
2484 Delete all addresses, including static addresses, from the address cache.
2485 .It Cm discover Ar interface
2486 Mark an interface as a
2489 When the bridge has no address cache entry
2490 (either dynamic or static)
2491 for the destination address of a packet,
2492 the bridge will forward the packet to all
2493 member interfaces marked as
2495 This is the default for all interfaces added to a bridge.
2496 .It Cm -discover Ar interface
2499 attribute on a member interface.
2500 For packets without the
2502 attribute, the only packets forwarded on the interface are broadcast
2503 or multicast packets and packets for which the destination address
2504 is known to be on the interface's segment.
2505 .It Cm learn Ar interface
2506 Mark an interface as a
2509 When a packet arrives on such an interface, the source
2510 address of the packet is entered into the address cache as being a
2511 destination address on the interface's segment.
2512 This is the default for all interfaces added to a bridge.
2513 .It Cm -learn Ar interface
2516 attribute on a member interface.
2517 .It Cm sticky Ar interface
2518 Mark an interface as a
2521 Dynamically learned address entries are treated at static once entered into
2523 Sticky entries are never aged out of the cache or replaced, even if the
2524 address is seen on a different interface.
2525 .It Cm -sticky Ar interface
2528 attribute on a member interface.
2529 .It Cm private Ar interface
2530 Mark an interface as a
2533 A private interface does not forward any traffic to any other port that is also
2534 a private interface.
2535 .It Cm -private Ar interface
2538 attribute on a member interface.
2539 .It Cm span Ar interface
2540 Add the interface named by
2542 as a span port on the bridge.
2543 Span ports transmit a copy of every frame received by the bridge.
2544 This is most useful for snooping a bridged network passively on
2545 another host connected to one of the span ports of the bridge.
2546 .It Cm -span Ar interface
2547 Delete the interface named by
2549 from the list of span ports of the bridge.
2550 .It Cm stp Ar interface
2551 Enable Spanning Tree protocol on
2555 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
2556 Spanning Tree is used to detect and remove loops in a network topology.
2557 .It Cm -stp Ar interface
2558 Disable Spanning Tree protocol on
2560 This is the default for all interfaces added to a bridge.
2561 .It Cm edge Ar interface
2565 An edge port connects directly to end stations cannot create bridging
2566 loops in the network, this allows it to transition straight to forwarding.
2567 .It Cm -edge Ar interface
2568 Disable edge status on
2570 .It Cm autoedge Ar interface
2573 to automatically detect edge status.
2574 This is the default for all interfaces added to a bridge.
2575 .It Cm -autoedge Ar interface
2576 Disable automatic edge status on
2578 .It Cm ptp Ar interface
2581 as a point to point link.
2582 This is required for straight transitions to forwarding and
2583 should be enabled on a direct link to another RSTP capable switch.
2584 .It Cm -ptp Ar interface
2585 Disable point to point link status on
2587 This should be disabled for a half duplex link and for an interface
2588 connected to a shared network segment,
2589 like a hub or a wireless network.
2590 .It Cm autoptp Ar interface
2591 Automatically detect the point to point status on
2593 by checking the full duplex link status.
2594 This is the default for interfaces added to the bridge.
2595 .It Cm -autoptp Ar interface
2596 Disable automatic point to point link detection on
2598 .It Cm maxage Ar seconds
2599 Set the time that a Spanning Tree protocol configuration is valid.
2600 The default is 20 seconds.
2601 The minimum is 6 seconds and the maximum is 40 seconds.
2602 .It Cm fwddelay Ar seconds
2603 Set the time that must pass before an interface begins forwarding
2604 packets when Spanning Tree is enabled.
2605 The default is 15 seconds.
2606 The minimum is 4 seconds and the maximum is 30 seconds.
2607 .It Cm hellotime Ar seconds
2608 Set the time between broadcasting of Spanning Tree protocol
2609 configuration messages.
2610 The hello time may only be changed when operating in legacy stp mode.
2611 The default is 2 seconds.
2612 The minimum is 1 second and the maximum is 2 seconds.
2613 .It Cm priority Ar value
2614 Set the bridge priority for Spanning Tree.
2615 The default is 32768.
2616 The minimum is 0 and the maximum is 61440.
2617 .It Cm proto Ar value
2618 Set the Spanning Tree protocol.
2619 The default is rstp.
2620 The available options are stp and rstp.
2621 .It Cm holdcnt Ar value
2622 Set the transmit hold count for Spanning Tree.
2623 This is the number of packets transmitted before being rate limited.
2625 The minimum is 1 and the maximum is 10.
2626 .It Cm ifpriority Ar interface Ar value
2627 Set the Spanning Tree priority of
2632 The minimum is 0 and the maximum is 240.
2633 .It Cm ifpathcost Ar interface Ar value
2634 Set the Spanning Tree path cost of
2638 The default is calculated from the link speed.
2639 To change a previously selected path cost back to automatic, set the
2641 The minimum is 1 and the maximum is 200000000.
2642 .It Cm ifmaxaddr Ar interface Ar size
2643 Set the maximum number of hosts allowed from an interface, packets with unknown
2644 source addresses are dropped until an existing host cache entry expires or is
2646 Set to 0 to disable.
2648 .Ss Link Aggregation and Link Failover Parameters
2649 The following parameters are specific to lagg interfaces:
2650 .Bl -tag -width indent
2651 .It Cm laggtype Ar type
2652 When creating a lagg interface the type can be specified as either
2656 If not specified ethernet is the default lagg type.
2657 .It Cm laggport Ar interface
2658 Add the interface named by
2660 as a port of the aggregation interface.
2661 .It Cm -laggport Ar interface
2662 Remove the interface named by
2664 from the aggregation interface.
2665 .It Cm laggproto Ar proto
2666 Set the aggregation protocol.
2669 The available options are
2677 .It Cm lagghash Ar option Ns Oo , Ns Ar option Oc
2678 Set the packet layers to hash for aggregation protocols which load balance.
2681 The options can be combined using commas.
2683 .Bl -tag -width ".Cm l2" -compact
2685 src/dst mac address and optional vlan number.
2687 src/dst address for IPv4 or IPv6.
2689 src/dst port for TCP/UDP/SCTP.
2692 Enable local hash computation for RSS hash on the interface.
2697 modes will use the RSS hash from the network card if available
2698 to avoid computing one, this may give poor traffic distribution
2699 if the hash is invalid or uses less of the protocol header information.
2701 disables use of RSS hash from the network card.
2702 The default value can be set via the
2703 .Va net.link.lagg.default_use_flowid
2714 Use the RSS hash from the network card if available.
2715 .It Cm flowid_shift Ar number
2716 Set a shift parameter for RSS local hash computation.
2717 Hash is calculated by using flowid bits in a packet header mbuf
2718 which are shifted by the number of this parameter.
2720 Enable selection of egress ports based on the native
2722 domain for the packets being transmitted.
2723 This is currently only implemented for lacp mode.
2726 hardware, running a kernel compiled with the
2728 option, and when interfaces from multiple
2730 domains are ports of the aggregation interface.
2732 Disable selection of egress ports based on the native
2734 domain for the packets being transmitted.
2735 .It Cm lacp_fast_timeout
2736 Enable lacp fast-timeout on the interface.
2737 .It Cm -lacp_fast_timeout
2738 Disable lacp fast-timeout on the interface.
2740 Enable lacp strict compliance on the interface.
2741 The default value can be set via the
2742 .Va net.link.lagg.lacp.default_strict_mode
2753 Disable lacp strict compliance on the interface.
2754 .It Cm rr_limit Ar number
2755 Configure a stride for an interface in round-robin mode.
2756 The default stride is 1.
2758 .Ss Generic IP Tunnel Parameters
2759 The following parameters apply to IP tunnel interfaces,
2761 .Bl -tag -width indent
2762 .It Cm tunnel Ar src_addr dest_addr
2763 Configure the physical source and destination address for IP tunnel
2769 are interpreted as the outer source/destination for the encapsulating
2772 Unconfigure the physical source and destination address for IP tunnel
2773 interfaces previously configured with
2776 Another name for the
2779 .It Cm accept_rev_ethip_ver
2780 Set a flag to accept both correct EtherIP packets and ones
2781 with reversed version field.
2783 This is for backward compatibility with
2785 6.2, 6.3, 7.0, and 7.1.
2786 .It Cm -accept_rev_ethip_ver
2788 .Cm accept_rev_ethip_ver .
2789 .It Cm ignore_source
2790 Set a flag to accept encapsulated packets destined to this host
2791 independently from source address.
2792 This may be useful for hosts, that receive encapsulated packets
2793 from the load balancers.
2794 .It Cm -ignore_source
2797 .It Cm send_rev_ethip_ver
2798 Set a flag to send EtherIP packets with reversed version
2799 field intentionally.
2800 Disabled by default.
2801 This is for backward compatibility with
2803 6.2, 6.3, 7.0, and 7.1.
2804 .It Cm -send_rev_ethip_ver
2806 .Cm send_rev_ethip_ver .
2808 .Ss GRE Tunnel Parameters
2809 The following parameters apply to GRE tunnel interfaces,
2811 .Bl -tag -width indent
2812 .It Cm tunnel Ar src_addr dest_addr
2813 Configure the physical source and destination address for GRE tunnel
2819 are interpreted as the outer source/destination for the encapsulating
2822 Unconfigure the physical source and destination address for GRE tunnel
2823 interfaces previously configured with
2826 Another name for the
2829 .It Cm grekey Ar key
2830 Configure the GRE key to be used for outgoing packets.
2832 .Xr gre 4 will always accept GRE packets with invalid or absent keys.
2833 This command will result in a four byte MTU reduction on the interface.
2835 .Ss Packet Filter State Table Sychronisation Parameters
2836 The following parameters are specific to
2839 .Bl -tag -width indent
2840 .It Cm syncdev Ar iface
2841 Use the specified interface
2842 to send and receive pfsync state synchronisation messages.
2844 Stop sending pfsync state synchronisation messages over the network.
2845 .It Cm syncpeer Ar peer_address
2846 Make the pfsync link point-to-point rather than using
2847 multicast to broadcast the state synchronisation messages.
2848 The peer_address is the IP address of the other host taking part in
2851 Broadcast the packets using multicast.
2853 Set the maximum number of updates for a single state which
2854 can be collapsed into one.
2855 This is an 8-bit number; the default value is 128.
2857 Defer transmission of the first packet in a state until a peer has
2858 acknowledged that the associated state has been inserted.
2860 Do not defer the first packet in a state.
2861 This is the default.
2864 The following parameters are specific to
2867 .Bl -tag -width indent
2868 .It Cm vlan Ar vlan_tag
2869 Set the VLAN tag value to
2871 This value is a 12-bit VLAN Identifier (VID) which is used to create an 802.1Q
2872 or 802.1ad VLAN header for packets sent from the
2879 must both be set at the same time.
2880 .It Cm vlanproto Ar vlan_proto
2881 Set the VLAN encapsulation protocol to
2883 Supported encapsulation protocols are currently:
2892 .It Cm vlanpcp Ar priority_code_point
2895 is an 3-bit field which refers to the IEEE 802.1p
2896 class of service and maps to the frame priority level.
2898 Values in order of priority are:
2900 .Pq Dv Background (lowest) ,
2902 .Pq Dv Best effort (default) ,
2904 .Pq Dv Excellent effort ,
2906 .Pq Dv Critical applications ,
2908 .Pq Dv Video, < 100ms latency and jitter ,
2910 .Pq Dv Voice, < 10ms latency and jitter ,
2912 .Pq Dv Internetwork control ,
2914 .Pq Dv Network control (highest) .
2915 .It Cm vlandev Ar iface
2916 Associate the physical interface
2921 Packets transmitted through the
2924 diverted to the specified physical interface
2926 with 802.1Q VLAN encapsulation.
2927 Packets with 802.1Q encapsulation received
2928 by the parent interface with the correct VLAN Identifier will be diverted to
2934 interface is assigned a
2935 copy of the parent interface's flags and the parent's Ethernet address.
2940 must both be set at the same time.
2943 interface already has
2944 a physical interface associated with it, this command will fail.
2946 change the association to another physical interface, the existing
2947 association must be cleared first.
2949 Note: if the hardware tagging capability
2950 is set on the parent interface, the
2953 interface's behavior changes:
2956 interface recognizes that the
2957 parent interface supports insertion and extraction of VLAN tags on its
2958 own (usually in firmware) and that it should pass packets to and from
2959 the parent unaltered.
2960 .It Fl vlandev Op Ar iface
2963 pseudo device, disassociate the parent interface from it.
2964 This breaks the link between the
2966 interface and its parent,
2967 clears its VLAN Identifier, flags and its link address and shuts the interface
2971 argument is useless and hence deprecated.
2973 .Ss Virtual eXtensible LAN Parameters
2974 The following parameters are used to configure
2977 .Bl -tag -width indent
2978 .It Cm vxlanid Ar identifier
2979 This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
2980 virtual network segment membership of the interface.
2981 .It Cm vxlanlocal Ar address
2982 The source address used in the encapsulating IPv4/IPv6 header.
2983 The address should already be assigned to an existing interface.
2984 When the interface is configured in unicast mode, the listening socket
2985 is bound to this address.
2986 .It Cm vxlanremote Ar address
2987 The interface can be configured in a unicast, or point-to-point, mode
2988 to create a tunnel between two hosts.
2989 This is the IP address of the remote end of the tunnel.
2990 .It Cm vxlangroup Ar address
2991 The interface can be configured in a multicast mode
2992 to create a virtual network of hosts.
2993 This is the IP multicast group address the interface will join.
2994 .It Cm vxlanlocalport Ar port
2995 The port number the interface will listen on.
2996 The default port number is 4789.
2997 .It Cm vxlanremoteport Ar port
2998 The destination port number used in the encapsulating IPv4/IPv6 header.
2999 The remote host should be listening on this port.
3000 The default port number is 4789.
3001 Note some other implementations, such as Linux,
3002 do not default to the IANA assigned port,
3003 but instead listen on port 8472.
3004 .It Cm vxlanportrange Ar low high
3005 The range of source ports used in the encapsulating IPv4/IPv6 header.
3006 The port selected within the range is based on a hash of the inner frame.
3007 A range is useful to provide entropy within the outer IP header
3008 for more effective load balancing.
3009 The default range is between the
3012 .Va net.inet.ip.portrange.first
3014 .Va net.inet.ip.portrange.last
3015 .It Cm vxlantimeout Ar timeout
3016 The maximum time, in seconds, before an entry in the forwarding table
3018 The default is 1200 seconds (20 minutes).
3019 .It Cm vxlanmaxaddr Ar max
3020 The maximum number of entries in the forwarding table.
3021 The default is 2000.
3022 .It Cm vxlandev Ar dev
3023 When the interface is configured in multicast mode, the
3025 interface is used to transmit IP multicast packets.
3026 .It Cm vxlanttl Ar ttl
3027 The TTL used in the encapsulating IPv4/IPv6 header.
3030 The source IP address and inner source Ethernet MAC address of
3031 received packets are used to dynamically populate the forwarding table.
3032 When in multicast mode, an entry in the forwarding table allows the
3033 interface to send the frame directly to the remote host instead of
3034 broadcasting the frame to the multicast group.
3035 This is the default.
3037 The forwarding table is not populated by received packets.
3039 Delete all dynamically-learned addresses from the forwarding table.
3040 .It Cm vxlanflushall
3041 Delete all addresses, including static addresses, from the forwarding table.
3044 The following parameters are used to configure
3046 protocol on an interface:
3047 .Bl -tag -width indent
3049 Set the virtual host ID.
3050 This is a required setting to initiate
3052 If the virtual host ID does not exist yet, it is created and attached to the
3053 interface, otherwise configuration of an existing vhid is adjusted.
3056 keyword is supplied along with an
3060 address, then this address is configured to be run under control of the
3062 Whenever a last address that refers to a particular vhid is removed from an
3063 interface, the vhid is automatically removed from interface and destroyed.
3064 Any other configuration parameters for the
3066 protocol should be supplied along with the
3069 Acceptable values for vhid are 1 to 255.
3070 .It Cm advbase Ar seconds
3071 Specifies the base of the advertisement interval in seconds.
3072 The acceptable values are 1 to 255.
3073 The default value is 1.
3074 .It Cm advskew Ar interval
3075 Specifies the skew to add to the base advertisement interval to
3076 make one host advertise slower than another host.
3077 It is specified in 1/256 of seconds.
3078 The acceptable values are 1 to 254.
3079 The default value is 0.
3080 .It Cm pass Ar phrase
3081 Set the authentication key to
3083 .It Cm state Ar state
3084 Forcibly change state of a given vhid.
3085 The following states are recognized:
3091 The following environment variables affect the execution of
3093 .Bl -tag -width IFCONFIG_FORMAT
3094 .It Ev IFCONFIG_FORMAT
3095 This variable can contain a specification of the output format.
3096 See the description of the
3098 flag for more details.
3101 Assign the IPv4 address
3103 with a network mask of
3107 .Dl # ifconfig em0 inet 192.0.2.10 netmask 255.255.255.0
3109 Add the IPv4 address
3111 with the CIDR network prefix
3115 .Dl # ifconfig em0 inet 192.0.2.45/28 alias
3117 Remove the IPv4 address
3121 .Dl # ifconfig em0 inet 192.0.2.45 -alias
3123 Enable IPv6 functionality of the interface:
3124 .Dl # ifconfig em0 inet6 -ifdisabled
3126 Add the IPv6 address
3127 .Li 2001:DB8:DBDB::123/48
3130 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123 prefixlen 48 alias
3131 Note that lower case hexadecimal IPv6 addresses are acceptable.
3133 Remove the IPv6 address added in the above example,
3136 character as shorthand for the network prefix:
3137 .Dl # ifconfig em0 inet6 2001:db8:bdbd::123/48 -alias
3139 Configure a single CARP redundant address on igb0, and then switch it
3141 .Bd -literal -offset indent -compact
3142 # ifconfig igb0 vhid 1 10.0.0.1/24 pass foobar up
3143 # ifconfig igb0 vhid 1 state master
3146 Configure the interface
3148 to use 100baseTX, full duplex Ethernet media options:
3149 .Dl # ifconfig xl0 media 100baseTX mediaopt full-duplex
3151 Label the em0 interface as an uplink:
3152 .Dl # ifconfig em0 description \&"Uplink to Gigabit Switch 2\&"
3154 Create the software network interface
3156 .Dl # ifconfig gif1 create
3158 Destroy the software network interface
3160 .Dl # ifconfig gif1 destroy
3162 Display available wireless networks using
3164 .Dl # ifconfig wlan0 list scan
3166 Display inet and inet6 address subnet masks in CIDR notation
3167 .Dl # ifconfig -f inet:cidr,inet6:cidr
3169 Display interfaces that are up with the exception of loopback
3170 .Dl # ifconfig -a -u -G lo
3172 Display a list of interface names beloning to the wlan group:
3173 .Bd -literal -offset indent -compact
3179 Display details about the interfaces belonging to the wlan group:
3180 .Bd -literal -offset indent -compact
3181 # ifconfig -a -g wlan
3182 wlan0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3183 ether 75:4c:61:6b:7a:73
3184 inet6 fe80::4c75:636a:616e:ffd8%wlan0 prefixlen 64 scopeid 0x3
3185 inet6 2001:5761:6e64:6152:6f6d:616e:fea4:ffe2 prefixlen 64 autoconf
3186 inet 192.168.10.5 netmask 0xffffff00 broadcast 192.168.10.255
3188 ssid "Hotspot" channel 11 (2462 MHz 11g) bssid 12:34:ff:ff:43:21
3189 regdomain ETSI country DE authmode WPA2/802.11i privacy ON
3190 deftxkey UNDEF AES-CCM 2:128-bit AES-CCM 3:128-bit txpower 30 bmiss 10
3191 scanvalid 60 protmode CTS wme roaming MANUAL
3192 parent interface: iwm0
3193 media: IEEE 802.11 Wireless Ethernet DS/2Mbps mode 11g
3195 nd6 options=23<PERFORMNUD,ACCEPT_RTADV,AUTO_LINKLOCAL>
3196 wlan1: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
3197 ether 00:50:69:6f:74:72
3199 ssid "" channel 2 (2417 MHz 11g)
3200 regdomain FCC country US authmode OPEN privacy OFF txpower 30 bmiss 7
3201 scanvalid 60 bgscan bgscanintvl 300 bgscanidle 250 roam:rssi 7
3202 roam:rate 5 protmode CTS wme bintval 0
3203 parent interface: rum0
3204 media: IEEE 802.11 Wireless Ethernet autoselect (autoselect)
3206 nd6 options=29<PERFORMNUD,IFDISABLED,AUTO_LINKLOCAL>
3209 Set a randomly-generated MAC address on tap0:
3210 .Dl # ifconfig tap0 ether random
3212 Messages indicating the specified interface does not exist, the
3213 requested address is unknown, or the user is not privileged and
3214 tried to alter an interface's configuration.
3236 Basic IPv6 node operation requires a link-local address on each
3237 interface configured for IPv6.
3238 Normally, such an address is automatically configured by the
3239 kernel on each interface added to the system or enabled; this behavior may
3240 be disabled by setting per-interface flag
3241 .Cm -auto_linklocal .
3242 The default value of this flag is 1 and can be disabled by using the sysctl
3244 .Va net.inet6.ip6.auto_linklocal .
3246 Do not configure IPv6 addresses with no link-local address by using
3248 It can result in unexpected behaviors of the kernel.
projects / FreeBSD / FreeBSD.git / blob